jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Fixup contributing docs and links (#31531)

Browse Source 
Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com>
This commit is contained in:
Jan Brasna
2024-02-08 21:30:40 +01:00
committed by GitHub
parent 99bf908593
commit 6306b5fc3e
2 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.github/CONTRIBUTING.md vendored
View File

@@ -10,7 +10,7 @@ Use the table of contents icon <img src="/contributing/images/table-of-contents.
## New contributor guide ## New contributor guide
To get an overview of the project, read the [README](README.md) file. Here are some resources to help you get started with open source contributions: To get an overview of the project, read the [README](../README.md) file. Here are some resources to help you get started with open source contributions:
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) - [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
- [Set up Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git) - [Set up Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git)
@@ -20,7 +20,7 @@ To get an overview of the project, read the [README](README.md) file. Here are s
## Getting started ## Getting started
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:. For more information on how we write our markdown files, see "[Using Markdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs). To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:. For more information on how we write our markdown files, see "[Using Markdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs)."
Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:. Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:.
@@ -56,13 +56,13 @@ For more information about using a codespace for working on GitHub documentation
- Using the command line: - Using the command line:
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
2. Install or update to **Node.js**, at the version specified in `.node-version`. For more information, see [the development guide](contributing/development.md). 2. Install or update to **Node.js**, at the version specified in `.node-version`. For more information, see [the development guide](../contributing/development.md).
3. Create a working branch and start with your changes! 3. Create a working branch and start with your changes!
### Commit your update ### Commit your update
Commit the changes once you are happy with them. Don't forget to use the "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist) to speed up the review process :zap:. Commit the changes once you are happy with them. Don't forget to use the "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist)" to speed up the review process :zap:.
### Pull Request ### Pull Request

7
contributing/development.md
View File

@@ -44,7 +44,7 @@ The [`src/bookmarklets`](../src/bookmarklets) directory contains some browser sh
By default the local server won't run with all supported languages enabled. If you need to run the server with a particular language, you can temporarily edit the `start` script in `package.json` and update the `ENABLED_LANGUAGES` variable. For example, to enable Japanese and Portuguese, you can set it to `ENABLED_LANGUAGES='en,ja,pt'` and then you need to restart the server for the change to take effect. By default the local server won't run with all supported languages enabled. If you need to run the server with a particular language, you can temporarily edit the `start` script in `package.json` and update the `ENABLED_LANGUAGES` variable. For example, to enable Japanese and Portuguese, you can set it to `ENABLED_LANGUAGES='en,ja,pt'` and then you need to restart the server for the change to take effect.
The supported language codes are defined in [lib/languages.js](#src/languages/lib/languages.js). The supported language codes are defined in [lib/languages.js](../src/languages/lib/languages.js).
## Site structure ## Site structure
@@ -69,6 +69,5 @@ For more info about working with this site, check out these READMEs:
- [data/README.md](../data/README.md) - [data/README.md](../data/README.md)
- [data/reusables/README.md](../data/reusables/README.md) - [data/reusables/README.md](../data/reusables/README.md)
- [data/variables/README.md](../data/variables/README.md) - [data/variables/README.md](../data/variables/README.md)
- [src/content-render/README.md](src/content-render/README.md) - [src/content-render/README.md](../src/content-render/README.md)
- [includes/README.md](../includes/README.md) - [src/README.md](../src/README.md)
- [src/README.md](src/README.md)