You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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

 

1) DO NOT create any new version of the overall documentation on readme.io until the new release gets rolled out.

If you want to add any new document pertaining to the next release, create it within the 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.
2) Send all the documentation updates for review to Denis Magda (dmagda@apache.org) and Prachi Garg (pgarg@gridgain.com).
  • No labels