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

Documentation Engineering - API/DocHub/LTD/Deployment

    Details

    • Type: Epic
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Epic Name:
      sqre-s17-doceng
    • Story Points:
      30
    • WBS:
      1.02C.10.02
    • Team:
      SQuaRE
    • Cycle:
      Spring 2017

      Description

      This epic covers work on the serving, curation and generation of documentation, continuing on from the F16 Epics for LSST-the-Docs, DocHub and API documentation.

      Deliverables include:

      • ChatOps creation and deployment of technotes (this removes Jonathan as gartekeeper to the process)
      • Index listing of all the technotes

      JS: 50% AT: 50%

        Attachments

        Stories in Epic (Custom Issue Matrix)

        Key Summary Story Points Assignee Status
         
        DM-9891

        Render index HTML page for www.lsst.io

        1 Adam Thornton Done
         
        DM-9865

        Implement MVP for DocHubProto

        4 Adam Thornton Done
         
        DM-9818

        Design dochub-prototype (www.lsst.io builder)

        1 Jonathan Sick Done
         
        DM-9815

        Temporarily mitigate loss of docs.scipy.org from blocking pipelines.lsst.io and developer.lsst.io builds

        0.2 Jonathan Sick Done
         
        DM-9256

        Fix Search on developer.lsst.io

        0.2 Jonathan Sick Done
         
        DM-9224

        Refactor Fastly API client from LTD Keeper to LTD Conveyor

        0.4 Jonathan Sick Done
         
        DM-9608

        Fix LTD Dasher title processing (handle removal)

        0.5 Jonathan Sick Done
         
        DM-9779

        Relieve LTD Mason of setting S3 object ACLs

        0.8 Jonathan Sick Done
         
        DM-9686

        Add LSST branding to pipelines.lsst.io

        1 Jonathan Sick Done
         
        DM-9069

        Create chatops service for cookiecutter microservice

        3 Adam Thornton Done
         
        DM-9068

        Licensing in codekit no longer pushes changes.

        Adam Thornton Done
         
        DM-9020

        Create common S3 upload/interface Python package for LSST the Docs microservices and clients

        3.7 Jonathan Sick Done
         
        DM-8996

        Bootstrapper microservice

        8 Adam Thornton Done
         
        DM-9086

        Add post-repository-creation hooks to cookiecutter services

        6 Adam Thornton Done
         
        DM-9106

        Make sqrbot reply to interlocutor

        1 Adam Thornton Done
         
        DM-9097

        Fix lsst-sphinx-bootstrap-theme deployment

        0.5 Jonathan Sick Done
         
        DM-9090

        Updates to Microservice cookiecutter from uservice-ccutter PR

        Adam Thornton Done
         
        DM-6120

        Add LSST branding and edit on GitHub button to Developer Guide

        1.6 Jonathan Sick Done
         
        DM-7198

        Document template for EUPS Stack packages in developer guide

        Jonathan Sick Invalid

          Activity

          Hide
          frossie Frossie Economou added a comment -

          Deliverables in this epic, now live in production, included:

          • Developer self-service is now available in technotes; you can ask the chatbot for a technote and everything will be created for you - Github rebo, Travis setup, and your xxx.lsst.io deployed document.This is implemented using the pre-existing tech stack plus our new API microservice infrastructure.
          • LSST branding was added to technotes and key web-published docs (eg the pipelines release notes)
          • A number of bug-fixes were made to the production doc services
          Show
          frossie Frossie Economou added a comment - Deliverables in this epic, now live in production, included: Developer self-service is now available in technotes; you can ask the chatbot for a technote and everything will be created for you - Github rebo, Travis setup, and your xxx.lsst.io deployed document.This is implemented using the pre-existing tech stack plus our new API microservice infrastructure. LSST branding was added to technotes and key web-published docs (eg the pipelines release notes) A microservice now returns an index of all technotes in both HTML and json, which is the first building block of DocHub (eg https://api.lsst.codes/ltdindexer/page/ ) A number of bug-fixes were made to the production doc services

            People

            • Assignee:
              jsick Jonathan Sick
              Reporter:
              frossie Frossie Economou
              Watchers:
              Frossie Economou
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel