[
https://issues.jboss.org/browse/SRAMP-74?page=com.atlassian.jira.plugin.s...
]
Kurt Stam commented on SRAMP-74:
--------------------------------
If you clone our wiki:
https://github.com/Governance/s-ramp/wiki/_access
Then in the 'guide' directory you can find the following Readme:
https://github.com/Governance/s-ramp/wiki/GuideReadme
I'm prefixing all files in the guide directory by Guide to avoid conflicts on the wiki
where this directory hierarchy is not reflected; and also it sorts nicely then. I have
attached the HTML and PDF versions the docbook builds (note nicely with numbers, TOC,
etc).
Users can update the asciidoc pages (one for each chapter) right in the wiki, and submit a
pull request.
Create documentation process
----------------------------
Key: SRAMP-74
URL:
https://issues.jboss.org/browse/SRAMP-74
Project: S-RAMP
Issue Type: Task
Security Level: Public(Everyone can see)
Affects Versions: Milestone 2 (Properties)
Reporter: Kurt Stam
Assignee: Kurt Stam
Fix For: Milestone 4
I'm thinking about creating the content using MarkDown (md) format. Github's wiki
supports this format and the docs end up as *md files in a github project.
This means that we can work on documentation while being offline, and users can alter the
docs in their fork and send us pull requests.
At release time we use a tool like pandoc to convert the md files to docbook format. The
docbook files should be checked in with the S-RAMP project itself. We can then put these
docbook based files out on
jboss.org.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see:
http://www.atlassian.com/software/jira