1585661 - Move Geckoview docs to mozilla central

Status: RESOLVED FIXED

(GeckoView :: General, enhancement, P2)

Description

[Emily Toop (:fluffyemily)]

Currently our documentation site is on github where all our user documentation is kept. This means that our documentation is not kept in the same place as our codebase. There are many disadvantages to this, such as it prevents us from doing things like importing example code from building source, which may result in our documentation not being up to date with changes and also means that we cannot tie documentation examples to the CHANGELOG or api.txt.

This bug is the first stage in addressing these issues - moving all of the markdown and examples that form the basis of our documentation site into Mozilla Central, and updating the github site documentation in the same way that we currently do with our Javadoc (copying from mc to gh).

Part of this issue may be looking at how we can lock down the github site to prevent commits from happening directly there, forcing all changes to come from edits in mc.

Things to consider:

1. How do we test jekyll changes from mc? Do we have to keep the entire jekyll site here in order to achieve that.
2. Do we need to add installation of Jekyll and associated tools alongside mach bootstrap to ensure that anyone is automatically set up to view locally, or just include instructions for those that need them.
3. Do we handle user docuementation in a separate task to javadoc, or should they be lumped together under gv-docs.

Comment 1

[Chris Peterson [:cpeterson]]

Emily says she's working on this bug.

Comment 2

[Emily Toop (:fluffyemily)]

Attachment: Bug 1585661 - Move geckoview user documentation under mozilla-central. r?agi

Examples are being moved to a new location and javadoc is already generated here and so these items are not being moved in this commit

Comment 3

[Emily Toop (:fluffyemily)]

Attachment: Bug 1585661 - Update mach geckoview-docs command to upload markdown as well as javadoc. r?agi

Depends on D48563

Comment 4

[Emily Toop (:fluffyemily)]

Attachment: Bug 1585661 - Add messaging examples to Android Studio. r?agi

Depends on D48564

Comment 5

[Emily Toop (:fluffyemily)]

Attachment: Bug 1585661 - Update WebExtension docs to point to example code in mozilla-central. r?agi

Depends on D48565

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/86ebbb20ef06
Move geckoview user documentation under mozilla-central. r=agi,nalexander,ahal

Comment 7

[Alexandru Michis [:malexandru]]

Backed out changeset 86ebbb20ef06 for causing lint failures.

Backout link: https://hg.mozilla.org/integration/autoland/rev/4f023a5eb661107b5eff50c1541d0a180eeeb231

Push with failures: https://treeherder.mozilla.org/#/jobs?repo=autoland&searchStr=linting%2Copt&tochange=4f023a5eb661107b5eff50c1541d0a180eeeb231&fromchange=331dbc89e3003cfc5510877b601243e6be06be8e&group_state=expanded&selectedJob=273482856

Failure log:

• For the rst fails:
  https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=273482856&repo=autoland&lineNumber=312
• For the license fails:
  https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=273482857&repo=autoland&lineNumber=58

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/f53d1c154f7d
Move geckoview user documentation under mozilla-central. r=agi,nalexander,ahal

Comment 9

[Natalia Csoregi [:nataliaCs]]

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

Comment 10

[Emily Toop (:fluffyemily)]

Only one of the 4 associated patches landed. Reopening until the rest land too.

Comment 11

[Sylvestre Ledru [:Sylvestre]]

Emily, the doc doesn't show on https://firefox-source-docs.mozilla.org/
Probably because this website expects rst while geckoview doc is using markdown.
Do you have plan to make this doc available in https://firefox-source-docs.mozilla.org/ too ?
thanks!

Comment 12

[Emily Toop (:fluffyemily)]

We are currently using these docs to publish to the GV documentation site https://geckoview.dev (or at least will do once I get the r+ for the changes to the mach command). What would I have to do to these docs to make them also appear on https://firefox-source-docs.mozilla.org/ too? Or are the two formats (Jekyll for GH Pages and rst for firefox docs) too incompatible?

Comment 13

[Sylvestre Ledru [:Sylvestre]]

I created bug 1593218 to keep track of this work :)

Comment 14

[Chris Peterson [:cpeterson]]

Setting firefox71=wontfix because we don't need to uplift these doc changes to Beta.

Comment 15

[Arthur Iakab [arthur_iakab]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/f53d1c154f7d

Comment 16

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1f2c6dc5a14e
Update mach geckoview-docs command to upload markdown as well as javadoc. r=agi
https://hg.mozilla.org/integration/autoland/rev/c1e90bf96e14
Add messaging examples to Android Studio. r=agi

Comment 17

[Emily Toop (:fluffyemily)]

Attachment: Bug 1585661 fix lint errors

Comment 18

[Emily Toop (:fluffyemily)]

Attachment: Bug 1585661 fix lint errors

Comment 19

[Alexandru Michis [:malexandru]]

Backed out 2 changesets (Bug 1585661) for causing lint failures.

Backout link: https://hg.mozilla.org/integration/autoland/rev/3a3dda1714d5fb4b818e0a78cc8291b6c98f056f

Push with failures: https://treeherder.mozilla.org/#/jobs?repo=autoland&resultStatus=testfailed%2Cbusted%2Cexception&tochange=9f6892c03bd8dfcc604461ea90e71430c220fb74&fromchange=c1e90bf96e148837a484347c9e4cacbe9cdd028c&searchStr=lint

Failure logs:

• https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=276188860&repo=autoland&lineNumber=222
• https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=276188958&repo=autoland&lineNumber=58

Comment 20

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/126b37477819
Update mach geckoview-docs command to upload markdown as well as javadoc. r=agi
https://hg.mozilla.org/integration/autoland/rev/915910348bce
Add messaging examples to Android Studio. r=agi

Comment 21

[Pulsebot]

Backout by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/2fe825d522b2
Backed out 2 changesets for causing lint failures. CLOSED TREE

Comment 22

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b7d60a096dae
Update mach geckoview-docs command to upload markdown as well as javadoc. r=agi

Comment 23

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

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