| Issue 2842: | Documentation for Release Candidates and master should be built and published | |
| 2 people starred this issue and may be notified of changes. | Back to list |
If I go the Gerrit website: * I can view the documentation and release notes for the current and prior releases * However, there doesn't seem to be any link to the documentation and release notes for non-released versions. Are these even built? I would like to be able to view the documentation / release notes for release candidates and master. The Jenkins jobs should build and publish these, and they should be linked (not necessarily directly) from the main Gerrit website. The documentation / release notes for unreleased versions should probably be marked somehow as "pre-release and subject to change".
Aug 20, 2014
Project Member
#1
david.pu...@sonymobile.com
Aug 20, 2014
@Luca would it be possible to add a documentation build on the CI?
Cc:
luca.mil...@gmail.com
Aug 20, 2014
@David all the builds on CI are done with documentation included. Do you mean to unpack the war and publish the standalone HTML somewhere ? I guess we need a Gerrit instance to serve them as they include a search box.
Aug 20, 2014
@Luca the intention was to publish the documentation somewhere, yes. There is a "Search box" header at the bottom, but it's empty if the documentation is viewed standalone. Alternatively, the documentation can be built standalone by running make in the Documentation folder, rather than unpacking it from the war file. It can then be viewed in a browser. The formatting might not be exactly the same as in the Gerrit war, because the make builds it with asciidoc rather than asciidoctor. But it should be good enough, I think.
Aug 21, 2014
@David fair enough, better not fully formatted / searchable than not accessible at all :-) Will configure a post-build step to publish the doc somewhere and share the link.
Aug 21, 2014
@David the links you provided are useful. Maybe all that needs to happen is that these be added to the Gerrit project home page? |
|
| ► Sign in to add a comment |