You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 10
Next »
Basics
Apache Ignite is broadly documented both in a form of Java docs and on https://apacheignite.readme.io. To make docs consistent and up-to-date follow this approach before closing a JIRA ticket:
- Update existing Java docs and create new ones if required. A committer who accepts the contribution is responsible for the Java docs review.
- Feel free to update readme.io docs before closing the JIRA ticket and assign it for review to docs maintainers or:
- Close the original JIRA ticket.
- Create a new JIRA ticket setting "component" property to "documentation" and link it to the original one. The "Fix Version" should be the same as in the original ticket.
- Assign the new documentation ticket on Denis Magda (dmagda@apache.org) providing all the details needed to document a functionality properly.
Readme.io Docs for a Next Release (outdated, see next section)
If you are one of readme.io docs maintainers, rely on this approach if you need to work on a doc for a functionality to be released in the future:
- DO NOT create a new version of readme.io docs until a new Apache Ignite version gets released officially.
- If you want to add a new document pertaining to the next release, create it within a document for the current version and keep the page hidden.
- If you need to update an existing page then clone it, name as {page-name-new-version}, refine and left hidden as well.
- The added hidden pages will be released and a new readme.io docs version will be created as a part of Apache Ignite release process.
How To Release New Documentation Version
- Follow this instruction to install `jekyll` and `asciidoctor` on your machine: https://github.com/apache/ignite/blob/IGNITE-7595/docs/README.adoc
- Check out the apache ignite web-site repository (https://github.com/apache/ignite-website)
- Go to the "_docs" folder
- Run `./build.sh --version={version} --github-branch={branch} latest`
The script pulls the given branch from the apache-ignite code base repository and generates the docs from the adoc files. The resulting HTML files are located in the "/docs" directory.
For example:
./build.sh --version=2.9.0 --github-branch=IGNITE-7595
- Push the generated files to master. They will be published automatically.
Documentation Maintainers