Skip to content
This repository was archived by the owner on Apr 24, 2023. It is now read-only.

Home

Jump to bottom
Paul Wright edited this page May 5, 2020 · 1 revision

Welcome to the user-documentation wiki!

Goals

  • Enable devs to draft expected use cases

  • Capture code examples in asciidoc

  • Provide 'raw' material to writers

  • Separate eng-doc requirements from CCS-doc requirements

Procedure

When a dev identifies some procedure that requires documentation:

  1. Write up a procedure as a new page on https://github.com/integr8ly/user-documentation/wiki

  2. Eng review can be as simple as reviewer editing that page with 'lgtm'

  3. Dev adds link to page in the associated jira

  4. When documenting a user story, a writer can reference this material.

The wiki supports asciidoc, so when an existing procedure is being modified, the eng can get the source material from: https://gitlab.cee.redhat.com/RedHatManagedIntegration-documentation/rhmi-docs/

Clone this wiki locally