Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-19478

Documentation templates

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      This task is to make progress on the team documentation. We know we need in line documentation hosted to make out software documentation more accessible. 

        Attachments

          Activity

          No builds found.
          aheyer Andrew Heyer [X] (Inactive) created issue -
          Hide
          aheyer Andrew Heyer [X] (Inactive) added a comment -

          Met with Jonathan and Eric. Notes are recorded on google doc, the equivalent of what I have on this google doc will eventually be recorded onto a GitHub repo that outlines how a developer is to go about documenting their code.  

          https://docs.google.com/document/d/1DwsnjtWn6TIG7WaZXrC6qctSjKEumbZovyyB0zVdfTQ/edit

          An important fact I learned is that as long as whatever tool we use to do our source code documentation produces static HTML, Jonathan can take care of the rest via Travis. My real only concern going into this was requiring a C++ developer need python to do whatever uploading of HTML generation but this will not be the case.

          The next step in this effort is to create the template, Eric agreed to take on the template for Python. I will create the template for Java and C++, getting ts_sal done and a how to guide going over building sal I think will be a good place to start with this. 

          Show
          aheyer Andrew Heyer [X] (Inactive) added a comment - Met with Jonathan and Eric. Notes are recorded on google doc, the equivalent of what I have on this google doc will eventually be recorded onto a GitHub repo that outlines how a developer is to go about documenting their code.   https://docs.google.com/document/d/1DwsnjtWn6TIG7WaZXrC6qctSjKEumbZovyyB0zVdfTQ/edit An important fact I learned is that as long as whatever tool we use to do our source code documentation produces static HTML, Jonathan can take care of the rest via Travis. My real only concern going into this was requiring a C++ developer need python to do whatever uploading of HTML generation but this will not be the case. The next step in this effort is to create the template, Eric agreed to take on the template for Python. I will create the template for Java and C++, getting ts_sal done and a how to guide going over building sal I think will be a good place to start with this. 
          aheyer Andrew Heyer [X] (Inactive) made changes -
          Field Original Value New Value
          Reviewers Eric Coughlin [ ecoughlin ] Andy Clements [ aclements ]
          Status To Do [ 10001 ] In Review [ 10004 ]
          aheyer Andrew Heyer [X] (Inactive) made changes -
          Reviewers Andy Clements [ aclements ] Eric Coughlin [ ecoughlin ]
          Hide
          ecoughlin Eric Coughlin added a comment -

          Can confirm that this happened.

          Show
          ecoughlin Eric Coughlin added a comment - Can confirm that this happened.
          ecoughlin Eric Coughlin made changes -
          Status In Review [ 10004 ] Reviewed [ 10101 ]
          aheyer Andrew Heyer [X] (Inactive) made changes -
          Resolution Done [ 10000 ]
          Status Reviewed [ 10101 ] Done [ 10002 ]
          aclements Andy Clements made changes -
          Epic Link DM-24280 [ 432909 ]
          aclements Andy Clements made changes -
          Urgent? off

            People

            Assignee:
            aheyer Andrew Heyer [X] (Inactive)
            Reporter:
            aheyer Andrew Heyer [X] (Inactive)
            Reviewers:
            Eric Coughlin
            Watchers:
            Andrew Heyer [X] (Inactive), Andy Clements, Eric Coughlin
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.