Page History

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 required needed to document a functionality properly.

...

Readme.io Docs for a Next Release

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

any

a new document pertaining to the next release, create it within

the

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.