Set up auto publish of doc index per Boston workweek agreement

RESOLVED FIXED

Status

Release Engineering
General
RESOLVED FIXED
3 years ago
3 months ago

People

(Reporter: hwine, Assigned: hwine)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

(Whiteboard: [kanban:engops:https://mozilla.kanbanize.com/ctrl_board/6/2009] )

(Assignee)

Description

3 years ago
In November 2013, we agreed on some improvements to our documentation practices.

One key component of that was an easy-to-update document index, based on :catlee's relengdocs repo.

This bug is to set that up, either internally (preferred) or on readthedocs

Future work includes:
 - adding in code docs auto generated from our sources
 - export to media-wiki when docs are stable enough to be put in wiki.m.o
(Assignee)

Comment 1

3 years ago
RelEng docs repo now available at:
  https://github.com/mozilla/build-relengdocs

Formatted docs now available at:
  http://docs.pub.build.mozilla.org/

These do not yet auto update. Ping :hwine if you need a commit published.
(Assignee)

Updated

3 years ago
Blocks: 879285
(Assignee)

Updated

3 years ago
Depends on: 980990
(Assignee)

Comment 2

3 years ago
Decided to move to readthedocs. Next steps:
 - set up shared account
 - add webhooks to github repositories
 - add postcommit hook for hg.m.o repos
(In reply to Hal Wine [:hwine] (use needinfo) from comment #2)
> Decided to move to readthedocs. Next steps:
>  - set up shared account

For what its worth readthedocs has the concept of multiple admins on a doc, e.g. me and bhearsum are admins of http://mozilla-slaveapi.readthedocs.org/en/latest/

I propose we all should have individual accounts on there.

Updated

3 years ago
Whiteboard: [kanban:engops:https://mozilla.kanbanize.com/ctrl_board/6/2002]

Updated

3 years ago
Whiteboard: [kanban:engops:https://mozilla.kanbanize.com/ctrl_board/6/2002] → [kanban:engops:https://mozilla.kanbanize.com/ctrl_board/6/2009]
(Assignee)

Comment 4

2 years ago
This work is done. There's a master account (credentials in passowrd store), but all work is done by folks under their rtfd id's, as suggested in comment 3
Status: NEW → RESOLVED
Last Resolved: 2 years ago
Resolution: --- → FIXED
Component: Tools → General
Product: Release Engineering → Release Engineering
You need to log in before you can comment on or make changes to this bug.