Skip to content

Commit 171b76d

Browse files
leon-winbsmth
andauthored
Update links in base documents (CONTRIBUTING.md, README.md, REVIEWING.md) (#38369)
* update links in base documents * revert Markdown links reference syntax * add comment about Markdown links reference syntax --------- Co-authored-by: Brian Smith <[email protected]>
1 parent d8a660f commit 171b76d

File tree

3 files changed

+32
-13
lines changed

3 files changed

+32
-13
lines changed

CONTRIBUTING.md

+17-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MDN Web Docs contribution guide
22

3-
Thanks for taking the time to contribute to [MDN Web Docs](https://developer.mozilla.org)! :tada:
3+
Thanks for taking the time to contribute to [MDN Web Docs][]! :tada:
44

55
This document covers project setup steps along with a set of guidelines for contributing to MDN Web Docs content.
66
Everyone participating in this project is expected to follow our [Code of Conduct](https://github.com/mdn/content/blob/main/CODE_OF_CONDUCT.md), which means adhering to [Mozilla's Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/).
@@ -20,7 +20,7 @@ We expect contributors to MDN to have some knowledge of web technologies before
2020
We've put together relevant resources to get up to speed on specific topics before contributing:
2121

2222
- **Open source:** If you're new to open source projects, see the [Open source etiquette][] page.
23-
- **Git and GitHub:** If you are unfamiliar with these, see the section [Getting ready to contribute][] to get pointers on where to start.
23+
- **Git and GitHub:** If you are unfamiliar with these, see the section [What do I need to get started?][] to get pointers on where to start.
2424
- **Web technologies:** HTML, CSS, JavaScript, and more are covered in our [Learn web development][] tutorials.
2525
- **MDN repositories:** To find out where everything lives in various MDN repositories, see our [MDN Web Docs repositories][] page.
2626

@@ -222,7 +222,7 @@ If you have a [local checkout](#forking-and-cloning-the-repository) of the repos
222222

223223
> [!NOTE]
224224
> Automatically formatting changes does not work for pull requests opened using the GitHub Web UI as described in the ["Simple changes" section](#simple-changes).
225-
> This may result in failed status checks on pull requests. If you're not sure about how to fix this, [get in touch with us][]! for help.
225+
> This may result in failed status checks on pull requests. If you're not sure about how to fix this, [get in touch with us][] for help.
226226
227227
### Adding a new document
228228

@@ -419,14 +419,21 @@ There are some important rules of etiquette to remember that will help during th
419419
When contributing to the content you agree to license your contributions
420420
according to [our license](LICENSE.md).
421421

422+
<!---
423+
Reference links syntax is used here because of linting markdown files ("fqdn-moz-links" rule).
424+
See https://github.com/mdn/content/pull/21432 and https://github.com/mdn/content/pull/38369.
425+
It can be replaced with the normal links syntax after successfully closing https://github.com/DavidAnson/markdownlint/issues/673.
426+
-->
427+
428+
[mdn web docs]: https://developer.mozilla.org
429+
[getting started with mdn web docs]: https://developer.mozilla.org/en-US/docs/MDN/Community/Getting_started
422430
[community resources]: https://developer.mozilla.org/en-US/docs/MDN/Community
423-
[getting started with mdn web docs]: https://developer.mozilla.org/en-US/docs/MDN/Community/Contributing/Getting_started
424-
[getting ready to contribute]: https://developer.mozilla.org/en-US/docs/MDN/Community/Contributing/Getting_started#getting_ready_to_contribute
425-
[how to write in markdown]: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN
426-
[javascript landing page]: https://developer.mozilla.org/en-US/docs/Web/JavaScript
427-
[learn web development]: https://developer.mozilla.org/en-US/docs/Learn
428431
[writing guidelines]: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines
429-
[open source etiquette]: https://developer.mozilla.org/en-US/docs/MDN/Community/Open_source_etiquette
430-
[mdn web docs repositories]: https://developer.mozilla.org/en-US/docs/MDN/Community/Contributing/Our_repositories
431432
[writing style guide]: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide
433+
[how to write in markdown]: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Markdown_in_MDN
434+
[open source etiquette]: https://developer.mozilla.org/en-US/docs/MDN/Community/Open_source_etiquette
435+
[what do i need to get started?]: https://developer.mozilla.org/en-US/docs/MDN/Community/Getting_started#what_do_i_need_to_get_started
436+
[learn web development]: https://developer.mozilla.org/en-US/docs/Learn_web_development
437+
[mdn web docs repositories]: https://developer.mozilla.org/en-US/docs/MDN/Community/Our_repositories
438+
[javaScript landing page]: https://developer.mozilla.org/en-US/docs/Web/JavaScript
432439
[get in touch with us]: https://developer.mozilla.org/en-US/docs/MDN/Community/Communication_channels

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,11 @@ By participating in and contributing to our projects and discussions, you acknow
4646

4747
You can communicate with the MDN Web Docs team and community using the [communication channels][].
4848

49+
<!---
50+
Reference links syntax is used here because of linting markdown files ("fqdn-moz-links" rule).
51+
See https://github.com/mdn/content/pull/21432 and https://github.com/mdn/content/pull/38369.
52+
It can be replaced with the normal links syntax after successfully closing https://github.com/DavidAnson/markdownlint/issues/673.
53+
-->
54+
55+
[mdn web docs]: https://developer.mozilla.org
4956
[communication channels]: https://developer.mozilla.org/en-US/docs/MDN/Community/Communication_channels
50-
[MDN Web Docs]: https://developer.mozilla.org/

REVIEWING.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,13 @@ for all their help.
204204
- [@vkWeb](https://github.com/vkWeb/)
205205
- [@Ryuno-Ki](https://github.com/Ryuno-Ki)
206206

207-
[get in touch with us]: https://developer.mozilla.org/en-US/docs/MDN/Community/Contributing/Getting_started#what_can_i_do_to_help
207+
<!---
208+
Reference links syntax is used here because of linting markdown files ("fqdn-moz-links" rule).
209+
See https://github.com/mdn/content/pull/21432 and https://github.com/mdn/content/pull/38369.
210+
It can be replaced with the normal links syntax after successfully closing https://github.com/DavidAnson/markdownlint/issues/673.
211+
-->
212+
208213
[mdn code example guidelines]: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide
209214
[mdn writing style guide]: https://developer.mozilla.org/en-US/docs/MDN/Guidelines/Writing_style_guide
210-
[MDN Web Docs chat rooms]: https://developer.mozilla.org/en-US/docs/MDN/Community/Communication_channels
215+
[mdn web docs chat rooms]: https://developer.mozilla.org/en-US/docs/MDN/Community/Communication_channels
216+
[get in touch with us]: https://developer.mozilla.org/en-US/docs/MDN/Community/Getting_started#what_can_i_do_to_help

0 commit comments

Comments
 (0)