1868475 - [Outreachy] mobile/android/docs/geckoview/contributor/mc-quick-start.rst is outdated

Status: RESOLVED FIXED

(Developer Infrastructure :: Firefox Source Docs: Content, defect)

Description

[Tooru Fujisawa [:arai]]

https://searchfox.org/mozilla-central/source/mobile/android/docs/geckoview/contributor/mc-quick-start.rst

This document explains workflow on mozilla-central, with manual installation of git-cinnabar and manual setup for remotes, including mozilla-inbound.
which shouldn't be necessary with the latest workflow with bootstrap.py

https://firefox-source-docs.mozilla.org/setup/index.html

Comment 1

[BugBot [:suhaib / :marco/ :calixte]]

The severity field is not set for this bug.
:Sylvestre, could you have a look please?

For more information, please visit BugBot documentation.

Comment 2

[Dan Minor [:dminor]]

We should replace this reference with one to the main setup instructions, this is causing confusing for new contributors, including some of our Outreachy applicants.

Comment 3

[Dan Minor [:dminor]]

You can find all of the references to this file here: https://searchfox.org/mozilla-central/search?q=mc-quick-start&path=&case=false&regexp=false.

In contributing-to-mc.rst, change the reference from <mc-quick-start.html> to </setup/index.html>.

In index.rst Remove the two lines that refer to mc-quick-start.html.

Finally, remove mc-quick-start.rst completely.

Once done, you can commit your changes. Your commit message should look like: Bug 1868475 - Remove outdated getting started instructions; r=#geckoview-reviewers!

Once you have your changes committed, request review. There are instructions on using phabricator and on getting reviews.

Comment 4

[Dan]

I am looking into this issue

Comment 5

[Dan]

Attachment: Bug 1868475 - Remove outdated getting started instructions; r=#geckoview-reviewers!

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/37b8edee8c8e
Remove outdated getting started instructions; r=geckoview-reviewers,m_kato

Comment 7

[Sandor Molnar[:smolnar]]

Backed out for causing documentation failures

Backout link: https://hg.mozilla.org/integration/autoland/rev/03ec99e21978a4591113e6bb56e5f01692d4f2b3

Push with failures

Failure log

Comment 8

[Dan Minor [:dminor]]

Amazingly, it seems that the test just reports that one extra warning is present, leaving the reader to figure out which one of the 808 warnings is the new one.

I've tried searching the log for the files changed in the patch here and I'm not finding anything.

Comment 9

[Tooru Fujisawa [:arai]]

The new warning is the following one:

[task 2024-10-21T20:33:19.350Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/mobile/android/index.rst:26: WARNING: undefined label: 'mozilla central quick start'

that's the reference in the following line:

https://searchfox.org/mozilla-central/rev/faa7b1b2a7b509df04a8bafbf8520fc162ad1363/mobile/android/docs/index.rst#26

- :ref:`Mozilla Central Quick Start <Mozilla Central Quick Start>`

The reference was pointing the section defined by the following lines in mc-quick-start.rst, which is removed by this patch.

https://searchfox.org/mozilla-central/rev/faa7b1b2a7b509df04a8bafbf8520fc162ad1363/mobile/android/docs/geckoview/contributor/mc-quick-start.rst#3-5

===========================
Mozilla Central Quick Start
===========================

So, mobile/android/docs/index.rst should also be updated

Comment 10

[Dan]

Oh, I will update the patch accordingly.

Comment 11

[Dan Minor [:dminor]]

Thanks for tracking that down Arai :)

Comment 12

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/29109f21c9cb
Remove outdated getting started instructions; r=geckoview-reviewers,m_kato

Comment 13

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/29109f21c9cb