Uploaded image for project: 'Cost Management'
  1. Cost Management
  2. COST-5085

Create a documentation contribution guide created

XMLWordPrintable

    • 1
    • False
    • None
    • False

      Target Date: June 5th since we are having a backstage meeting. 

       

      We agreed as a team to add documentation to backstage. In the past we have relied on verbal sharing of knowledge or quick recorded demo calls. These are still useful but transient in nature. We need to create a central repository of knowledge that the team can build over time. We need to enable better documentation by the creation of a clear process for what, when, how documents are to be created. The first document should be the one defining the process of documenting stuff.

      A quick survey of the team revealed, we don't know how to do this. rhn-support-lcouzens did some initial investigation and scheduled a call for next week. Let's get the process of writing documents documented.

      1. Where do you add your markdown?
      2. Where is the table of contents maintained in backstage and updated so we can keep this organized at a higher level?
      3. Useful top level links for adding documentation.
      4. Best practices for documentation on the project
      5. When is it expected to document stuff.

      The delivery for this issue is a document in backstage that describes the above.

            rhn-support-lcouzens Luke Couzens
            kholdawa@redhat.com Kevan Holdaway
            Votes:
            0 Vote for this issue
            Watchers:
            7 Start watching this issue

              Created:
              Updated:
              Resolved: