Update gecko.readthedocs links to the new firefox-source-docs.mozilla.org location

RESOLVED FIXED in Firefox 57

Status

()

P2
normal
RESOLVED FIXED
a year ago
a year ago

People

(Reporter: chutten, Assigned: kausam2015, Mentored)

Tracking

Trunk
mozilla57
Points:
---

Firefox Tracking Flags

(firefox57 fixed)

Details

(Whiteboard: [good first bug][lang=rst][lang=js][lang=c++][lang=java])

Attachments

(1 attachment, 2 obsolete attachments)

13.21 KB, patch
chutten
: review+
Details | Diff | Splinter Review
(Reporter)

Description

a year ago
According to searchfox there are 15 remaining links in mozilla-central that are pointing at gecko.readthedocs.io: http://searchfox.org/mozilla-central/search?q=gecko.readthedocs&path=

gecko.readthedocs.io is no longer being updated (firefox source docs having exceeded the size limits of readthedocs). We are instead now hosting it on a domain mozilla controls at firefox-source-docs.mozilla.org

This bug is about changing those gecko.readthedocs.io links in the source tree to point to their new locations somewhere within firefox-source-docs.mozilla.org

This might not simply be a substitution of firefox-source-docs.mozilla.org for gecko.readthedocs.io as ReadTheDocs had "en/latest" in a lot of links and firefox-source-docs.mozilla.org doesn't.

Be sure to test the new links to make sure they point at valid locations.
(Reporter)

Updated

a year ago
Mentor: chutten

Comment 1

a year ago
Where  can I access the files because I am new to this field could you please help me?
also Where to start?
(Assignee)

Comment 2

a year ago
I am working on this bug.
(Assignee)

Comment 3

a year ago
Created attachment 8903989 [details] [diff] [review]
patchfile
Attachment #8903989 - Flags: review?(chutten)
Comment on attachment 8903989 [details] [diff] [review]
patchfile

Review of attachment 8903989 [details] [diff] [review]:
-----------------------------------------------------------------

This looks good, thanks!
There are only some minor trailing spaces that need to be removed before we can proceed.

Note that the standard commit message convention is "Bug XXX - ..." (vs. your "Bug XXX: ...").

::: mobile/android/base/java/org/mozilla/gecko/telemetry/TelemetryBackgroundReceiver.java
@@ +38,4 @@
>  /**
>   * Receives and processes telemetry broadcasts from background services, namely Sync.
>   * Nomenclature:
> + * - Bundled Sync Ping: a Sync Ping as documented at https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/sync-ping.html 

There is a trailing space here on this line, please remove it.

::: mobile/android/base/java/org/mozilla/gecko/telemetry/pingbuilders/TelemetryCorePingBuilder.java
@@ +36,4 @@
>  /**
>   * Builds a {@link TelemetryOutgoingPing} representing a core ping.
>   *
> + * See https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/core-ping.html 

There is a trailing space here on this line, please remove it.

::: mobile/android/base/java/org/mozilla/gecko/telemetry/pingbuilders/TelemetrySyncPingBundleBuilder.java
@@ +26,4 @@
>  
>  /**
>   * Responsible for building a Sync Ping, based on the telemetry docs:
> + * https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/sync-ping.html 

More trailing space.
Attachment #8903989 - Flags: review?(chutten) → feedback+
Assignee: nobody → kausam2015
Priority: -- → P2
(Assignee)

Comment 5

a year ago
Created attachment 8904321 [details] [diff] [review]
patchfile.patch
Attachment #8904321 - Flags: review?(gfritzsche)

Comment 6

a year ago
(In reply to Cosm from comment #2)
> I am working on this bug.

Sorry I am Totaly new to it
Could help me in finding where should I start ?
Comment on attachment 8904321 [details] [diff] [review]
patchfile.patch

Chris is back today, so i'm moving this review over to him.
Attachment #8904321 - Flags: review?(gfritzsche) → review?(chutten)
(In reply to ppaswanth3 from comment #6)
> (In reply to Cosm from comment #2)
> > I am working on this bug.
> 
> Sorry I am Totaly new to it
> Could help me in finding where should I start ?

Hi!
I think this is not the best medium to help you get started.
Please see the information over here, it gets you started and points you to chat and other forms of getting help:
https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Introduction
(Reporter)

Comment 9

a year ago
Comment on attachment 8904321 [details] [diff] [review]
patchfile.patch

Review of attachment 8904321 [details] [diff] [review]:
-----------------------------------------------------------------

Good work! Fix the one link and put r=chutten on the end of the first line of your commit message (a la https://developer.mozilla.org/en-US/docs/Mercurial/Using_Mercurial#Commit_Message_Conventions ), reupload it to this bug, and we'll be ready to get this code submitted.

::: devtools/docs/frontend/telemetry.md
@@ +38,4 @@
>  
>  New data types have been added over the years, so it's quite feasible that some of our probes are not the most suitable nowadays.
>  
> +There's more information about types (and telemetry in general) on [this page](https://developer.mozilla.org/en-US/docs/Mozilla/Performance/Adding_a_new_Telemetry_probe) and [this other page](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/index.html).

The second link should be https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/index.html
Attachment #8904321 - Flags: review?(chutten) → review+
(Assignee)

Comment 10

a year ago
Created attachment 8904633 [details] [diff] [review]
patchfile

Thank you Chris, for the pointing out the correction.
Attachment #8903989 - Attachment is obsolete: true
Attachment #8904321 - Attachment is obsolete: true
Attachment #8904633 - Flags: review?(chutten)
(Reporter)

Updated

a year ago
Attachment #8904633 - Flags: review?(chutten) → review+
(Reporter)

Comment 11

a year ago
I have marked this bug for checkin, so your code should reach the tree shortly and then be included in either tomorrow's or the next day's Nightly build of Firefox. Congratulations!

Do you need any help finding another patch to work on, or would you like to run through the list on Bugs Ahoy (https://www.joshmatthews.net/bugsahoy/?internals=1) to find something you find interesting?
Keywords: checkin-needed

Comment 12

a year ago
Pushed by ryanvm@gmail.com:
https://hg.mozilla.org/integration/mozilla-inbound/rev/dadf26985c95
Update gecko.readthedocs links to the new firefox-source-docs.mozilla.org location. r=chutten
Keywords: checkin-needed
https://hg.mozilla.org/mozilla-central/rev/dadf26985c95
Status: NEW → RESOLVED
Last Resolved: a year ago
status-firefox57: affected → fixed
Resolution: --- → FIXED
Target Milestone: --- → mozilla57
You need to log in before you can comment on or make changes to this bug.