Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This is a checklist for documentation initiative. It's goal is to maintain high quality of documenting new features for each release and ensure that the rest of the documentation is up-to-date.  

Mark the checkbox if the answer is a success or n/a.

Blueprint submission process

Does the blueprint...

  •  Contains a description of what kind of documentation will be written including:
    •  API description with examples
    •  CLI with examples
    •  User manual with or without UI screenshots
  •  Contains a description of what existing parts of documentation will be changed
  •  JIRA ticket for tracking documentation of this feature is created.

Release process

  •  The documentation mentioned in the JIRA ticket is created
  •  Pull Request for adding the docs to tungstenfabric/docs is created and merged
  •  JIRA ticket is closed.