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

Integrate qserv docs into the new doc system

    Details

    • Type: Story
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: None
    • Labels:

      Description

      See Frossie 11/04/2015 email to qserv-l list:

      {{5- Docs. So you guys have a sphinx site. Fab, that’ll make it super easy to drop it into the new doc system that hosts sphinx on readthedocs - you can see a small example here http://sqr-001.lsst.codes/en/master/ - the idea is to continuously deploy the docs so the release step should be very lightweight and doable via API calls. (My holy grail is to do a release with no local checkout involved). }}

        Attachments

          Issue Links

            Activity

            Hide
            jammes Fabrice Jammes added a comment -

            Hi Frossie Economou, Joshua Hoblitt,

            Could you please give me an example repos in github.com/lsst that use the new doc system?

            Can I use this doc:
            http://developer.lsst.io/en/latest/docs/package_docs.html#the-package-s-user-guide-in-docs
            How can I generate the documentation for u/fjammes/DM-4262 branch?
            Could you please provide me the url where it will be published, will it be: http://qserv.lsst.io/

            Thanks

            Show
            jammes Fabrice Jammes added a comment - Hi Frossie Economou , Joshua Hoblitt , Could you please give me an example repos in github.com/lsst that use the new doc system? Can I use this doc: http://developer.lsst.io/en/latest/docs/package_docs.html#the-package-s-user-guide-in-docs How can I generate the documentation for u/fjammes/ DM-4262 branch? Could you please provide me the url where it will be published, will it be: http://qserv.lsst.io/ Thanks
            Hide
            jsick Jonathan Sick added a comment -

            Hi Fabrice Jammes, sorry for the confusion. The technote platform (using Read the Docs, SQR-000) isn’t what we’ll be using for software documentation.

            Right now (as in, this week), we’re building a documentation deployment service that will run on Jenkins and be able to accommodate LSST build idiosyncrasies (such as Scons and Eups; at least for Science Pipelines we need to have the software installed to capture the Python API). It is described in SQR-006 (in progress).

            We can use the Qserv docs during the development and testing of the LSST the Docs platform. The problem is that I don’t know much about the Qserv codebase, whether it is package-based like Science Pipelines, so I don’t have a good idea of what Qserv’s requirements are. Would a hack session at the Joint Technical Meeting be good? Or do we need to coordinate on this earlier?

            http://qserv.lsst.io would be the right URL.

            Show
            jsick Jonathan Sick added a comment - Hi Fabrice Jammes , sorry for the confusion. The technote platform (using Read the Docs , SQR-000 ) isn’t what we’ll be using for software documentation. Right now (as in, this week), we’re building a documentation deployment service that will run on Jenkins and be able to accommodate LSST build idiosyncrasies (such as Scons and Eups; at least for Science Pipelines we need to have the software installed to capture the Python API). It is described in SQR-006 (in progress). We can use the Qserv docs during the development and testing of the LSST the Docs platform. The problem is that I don’t know much about the Qserv codebase, whether it is package-based like Science Pipelines, so I don’t have a good idea of what Qserv’s requirements are. Would a hack session at the Joint Technical Meeting be good? Or do we need to coordinate on this earlier? http://qserv.lsst.io would be the right URL.
            Hide
            jammes Fabrice Jammes added a comment -

            I think a hack session à Joint Technical Meeting would be perfect, thanks

            Show
            jammes Fabrice Jammes added a comment - I think a hack session à Joint Technical Meeting would be perfect, thanks
            Hide
            jammes Fabrice Jammes added a comment -

            Jonathan Sick, thanks so much for your time and explanations
            Having documentation for Qserv releases and 'cutting-edge' version (i.e. for eups tag qserv_YYYY_MM and qserv-dev tags) would be a perfect first step.

            Please let me know if you need additional informations.

            Show
            jammes Fabrice Jammes added a comment - Jonathan Sick , thanks so much for your time and explanations Having documentation for Qserv releases and 'cutting-edge' version (i.e. for eups tag qserv_YYYY_MM and qserv-dev tags) would be a perfect first step. Please let me know if you need additional informations.
            Hide
            jammes Fabrice Jammes added a comment -

            Hi Jonathan Sick,

            You let me know yesterday that Qserv can be integrate to new doc system without any additional work on my side, and that you'll be able to do the job.
            So, I don't really know how to handle this ticket. I assign it to you for now...

            Regards,

            Show
            jammes Fabrice Jammes added a comment - Hi Jonathan Sick , You let me know yesterday that Qserv can be integrate to new doc system without any additional work on my side, and that you'll be able to do the job. So, I don't really know how to handle this ticket. I assign it to you for now... Regards,
            Hide
            jsick Jonathan Sick added a comment -

            I’m fine with being assigned to the ticket. It’ll be one of the first uses once we launch LSST the Docs (around the end of this cycle).

            Show
            jsick Jonathan Sick added a comment - I’m fine with being assigned to the ticket. It’ll be one of the first uses once we launch LSST the Docs (around the end of this cycle).
            Hide
            jammes Fabrice Jammes added a comment -

            Thanks so much Jonathan Sick, please let me know if I can help

            Show
            jammes Fabrice Jammes added a comment - Thanks so much Jonathan Sick , please let me know if I can help
            Hide
            tjenness Tim Jenness added a comment -

            Are the Qserv team still interested in this?

            Show
            tjenness Tim Jenness added a comment - Are the Qserv team still interested in this?

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                jammes Fabrice Jammes
                Watchers:
                Fabrice Jammes, Frossie Economou, Jacek Becla, Jonathan Sick, Leanne Guy, Tim Jenness
              • Votes:
                0 Vote for this issue
                Watchers:
                6 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Summary Panel