1643293 - Make a documentation renderer at review phase

Status: RESOLVED FIXED

(Developer Infrastructure :: Source Documentation, enhancement, P3)

Description

[Emil Farisan]

User Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36

Comment 1

[Emil Farisan]

It would be great if we have a documentation renderer at review phase. It will make the reviewing process faster since reviewer doesn't have to pull the changes and build the documentation locally. They could just see the changes to the documentation on s3.

We could make a new job that builds the documentation whenever there is changes to doc files (.md and .rst) and upload it directly to s3.
https://searchfox.org/mozilla-central/source/tools/moztreedocs/mach_commands.py

Comment 2

[Andrew Halberstadt [:ahal]]

Fyi it's possible to view the results of a DocUp build on try by visiting this link:
http://gecko-docs.mozilla.org-l1.s3-website.us-west-2.amazonaws.com/

So if reviewbot were to run the DocUp task, it could post the link as a comment. The main issue is that try pushes will overwrite one another, so we'd need to modify the DocUp task to upload files to a namespace keyed by the push revision (and set an expiry of a week or so). Shouldn't be too hard to do.

Comment 3

[Emil Farisan]

(In reply to Andrew Halberstadt [:ahal] from comment #2)

Fyi it's possible to view the results of a DocUp build on try by visiting this link:
http://gecko-docs.mozilla.org-l1.s3-website.us-west-2.amazonaws.com/

So if reviewbot were to run the DocUp task, it could post the link as a comment. The main issue is that try pushes will overwrite one another, so we'd need to modify the DocUp task to upload files to a namespace keyed by the push revision (and set an expiry of a week or so). Shouldn't be too hard to do.

i cant seem to access the link.

Comment 4

[Sylvestre Ledru [:Sylvestre]]

probably because nothing has been uploaded recently.
You could use "try" with docup to try this :)

Comment 5

[Emil Farisan]

Attachment: Bug 1643293 - added new job in doc to render documentation at review phase r=sylvestre

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a788bf738a87
added new job in doc to render documentation at review phase r=sylvestre,ahal

Comment 7

[Dorel Luca [:dluca]]

https://hg.mozilla.org/mozilla-central/rev/a788bf738a87