Plugins Directory » Redmine Docson
Author: | Michele Tessaro | |
---|---|---|
Website: | https://github.com/mikitex70/redmine_docson | |
Code repository: | https://github.com/mikitex70/redmine_docson.git | |
Registered on: | 2016-08-11 (over 8 years ago) | |
Current version: | 0.1.2 | |
Compatible with: | Redmine 3.4.x, 3.3.x, 3.2.x, 3.1.x, 3.0.x | |
User ratings: |
Docson is a tool that can render JSON schemas in a more human readable format, embedded in web pages.
This plugin will allow adding Docson widgets into Redmine wiki pages and issues.
Example JSON from Docson :
Installation notes
Install redmine_docson plugin:
cd $REDMINE_HOME/plugins
git clone https://github.com/mikitex70/redmine_docson.git
Restart Redmine to load the new plugin
To install docson embedded into Redmine, download docson into $REDMINE_HOME/public directory. For example:
cd $REDMINE_HOME
git clone https://github.com/lbovet/docson.git
Be warned: if docson is embedded with Redmine, JSON schemas must be served by Redmine to avoid cross-origin issues. In this case create also a folder for JSON schemas:
mkdir $REDMINE_HOME/public/jsonSchemas
Next go to the plugin settings page and set the URL for Docson and the root path of the JSON schemas:
- for the Docson installation URL use a full URL (for example
http://myserver:port/docson
) or an URL relative to Redmine (example:/docson
), more simple if Docson installation is embedded. - for the JSON schemas base path use a path relative to the Docson URL (example:
/jsonSchemas
). Using a full URL is allowed, but schemas cannot be loaded from a server different from Docson server if they are not served following CORS specifications.
For more details check the homepage.
Changelog
0.1.2 (2017-07-16)
Compatible with Redmine 3.4.x, 3.3.x, 3.2.x, 3.1.x, 3.0.x.
Tested with Redmine 3.4.0.
0.1.1 (2016-09-10)
Compatible with Redmine 3.3.x, 3.2.x, 3.1.x, 3.0.x, 2.6.x.
0.1.0 (2016-07-09)
Compatible with Redmine 3.2.x, 3.1.x, 3.0.x.