Page MenuHomePhabricator
Create Task
Maniphest T205894

Generate documentation for Spicerack
Closed, ResolvedPublic
Actions

Description

As part of the parent Goal, generate documentation for Spicerack:

  • Wikitech page
  • Sphinx configuration to generate documentation from existing docstrings (see Cumin)
  • Add few introductory documentation pages
  • Add documentation generation to CI, both generation and publication on doc.w.o (see Cumin)

Details

SubjectRepoBranchLines +/-
Add link to Spicerack documentationintegration/docrootmaster+1 -0
doc: add documentation and its generationoperations/software/spicerackmaster+749 -32
operations/spicerack: publish documentationintegration/configmaster+17 -0
Customize query in gerrit

Related Objects
Search...

Event Timeline

Volans triaged this task as Medium priority.Oct 1 2018, 4:58 PM
Volans created this task.
Volans moved this task from Backlog to In Progress on the SRE-tools board.Dec 19 2018, 10:23 AM
gerritbot subscribed.Dec 19 2018, 11:16 AM

Change 480724 had a related patch set uploaded (by Volans; owner: Volans):
[operations/software/spicerack@master] doc: add documentation and its generation

https://gerrit.wikimedia.org/r/480724

gerritbot added a project: Patch-For-Review.Dec 19 2018, 11:16 AM
Volans moved this task from In Progress to In Code Review on the SRE-tools board.Dec 19 2018, 11:18 AM
gerritbot added a comment.Dec 19 2018, 11:28 AM

Change 480725 had a related patch set uploaded (by Volans; owner: Volans):
[integration/config@master] operations/spicerack: publish documentation

https://gerrit.wikimedia.org/r/480725

gerritbot added a comment.Dec 19 2018, 2:52 PM

Change 480724 merged by jenkins-bot:
[operations/software/spicerack@master] doc: add documentation and its generation

https://gerrit.wikimedia.org/r/480724

gerritbot added a comment.Dec 19 2018, 3:17 PM

Change 480725 merged by jenkins-bot:
[integration/config@master] operations/spicerack: publish documentation

https://gerrit.wikimedia.org/r/480725

Stashbot subscribed.Dec 19 2018, 3:20 PM

Mentioned in SAL (#wikimedia-releng) [2018-12-19T15:20:35Z] <hashar> Testing spicerack postmerge job for T205894: contint1001$ zuul enqueue --trigger gerrit --pipeline postmerge --project operations/software/spicerack --change 480724,2

hashar subscribed.Dec 19 2018, 3:21 PM

https://integration.wikimedia.org/ci/job/spicerack-tox-publish/1/

And it has pushed the doc to https://doc.wikimedia.org/spicerack/master/

I have not tested the tag based job but it should work.

gerritbot added a comment.Dec 19 2018, 3:32 PM

Change 480763 had a related patch set uploaded (by Volans; owner: Volans):
[integration/docroot@master] Add link to Spicerack documentation

https://gerrit.wikimedia.org/r/480763

gerritbot added a comment.Dec 19 2018, 3:47 PM

Change 480763 merged by jenkins-bot:
[integration/docroot@master] Add link to Spicerack documentation

https://gerrit.wikimedia.org/r/480763

Volans closed this task as Resolved.Dec 19 2018, 4:55 PM
Volans claimed this task.
Volans updated the task description. (Show Details)

All set, documentation available in https://doc.wikimedia.org/spicerack/ and linked in the wikitech pages for Spicerack and Cookbooks.

hashar added a comment.Dec 19 2018, 11:14 PM

Thank you for the CI setup!

Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL