Skip to content

Commit cc71eae

Browse files
committed
Updates - Denise suggestions
1 parent 9ad755c commit cc71eae

File tree

3 files changed

+37
-26
lines changed

3 files changed

+37
-26
lines changed
-7.63 KB
Binary file not shown.
6.07 KB
Loading

src/content/docs/style-guide/contributing.mdx

Lines changed: 37 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Contributing
2+
title: Contributions
33
description: |
44
sidebar:
55
order: 1
@@ -9,52 +9,55 @@ import { Steps } from "~/components"
99
The [Cloudflare Docs](https://developers.cloudflare.com/) are open source and hosted on the [cloudflare-docs repository](https://github.com/cloudflare/cloudflare-docs) on GitHub. This means that anyone, including those who are not part of the Cloudflare organization, can contribute to them. We welcome all suggestions that help keep our docs high quality and up to date.
1010

1111
To contribute to our docs, you will need to [create an account on GitHub](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github) (if you do not have one already) and log in. Then you have two options:
12-
* **[Create a GitHub issue](#create-a-github-issue)**: This is best if you want to quickly submit a general suggestion.
13-
* **[Create a GitHub pull request](#create-a-github-pull-request)**: This is best if you have a specific edit you want to make to a specific doc or docs. This option may require some setup, depending on what method you use.
12+
* **[Create a GitHub issue](#create-a-github-issue)** if you want to quickly submit a general suggestion.
13+
* **[Create a GitHub pull request](#create-a-github-pull-request)** if you have a specific edit you want to make to a specific doc or docs. This option may require some setup, depending on what method you use.
1414

1515
In addition to using the [Cloudflare Style Guide](/style-guide/) for guidance on grammar and style, we recommend browsing our [components](/style-guide/components/) to add additional formatting such as [notes](/style-guide/documentation-content-strategy/component-attributes/notes-tips-warnings/) and [code blocks](/style-guide/components/code/).
1616

1717
## Create a GitHub issue
18-
To contribute to our docs by creating a GitHub issue:
18+
To create a GitHub issue:
1919
<Steps>
2020
1. [Log in to GitHub](http://github.com/login) and go to the [cloudflare-docs repo](https://github.com/cloudflare/cloudflare-docs).
21-
2. Select **Issues** and then **New issue**. [Learn more about creating GitHub Issues.](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-an-issue)
21+
2. Select **Issues** and then **New issue**.
2222
3. Select the issue type, fill out the form, and select **Create**.
2323
</Steps>
24+
[Learn more about creating GitHub Issues.](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-an-issue)
2425

2526
## Create a GitHub pull request
26-
There are several methods you can use to edit the Cloudflare Docs by creating a pull request:
27-
* **[Edit page](#edit-page)**This is the simplest way. It is best if you only want to edit one doc, only want to use your web browser, and do not need to preview your changes.
28-
* **[Create with Codespace](#create-with-codespace)**This is best if you want to edit multiple docs, only want to use your web browser, and want to preview your changes.
29-
* **[Edit locally](#edit-locally)**This is the more-advanced way that requires setting up a local environment. Like the Codespace method, it allows you to edit multiple docs and preview your changes.
27+
There are several method you can use to create a pull request:
28+
* **[Edit page](#edit-page)**: This is best if you only want to edit one page, only want to use your web browser, and do not need to preview your changes.
29+
* **[Create with Codespace](#create-with-codespace)**: This is best if you want to edit multiple pages, only want to use your web browser, and want to preview your changes.
30+
* **[Edit locally](#edit-locally)**: This more advanced method requires setting up a local environment. Like the Codespace method, it allows you to edit multiple pages and preview your changes.
3031
[Learn more about creating pull requests on GitHub.](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
3132

3233
### Edit page
3334
To create a GitHub pull request using the edit page method:
3435
<Steps>
3536
1. [Log in to GitHub](http://github.com/login).
36-
2. Open the doc from the [Cloudflare Docs](https://developers.cloudflare.com/) that you want to edit, scroll to the bottom left corner of the doc, and select **Edit page**:![Edit page icon](~/assets/images/style-guide/ui-elements/edit-page.png)
37-
3. You will see a GitHub landing page that says “You need to fork this repository to propose changes.” Select **Fork this repository**.
38-
4. You will see the markdown of the doc. Make your edits and select **Commit changes**.
39-
5. In the form, update the **Commit message** with the product you changed in brackets and a brief description of your changes. For example “[Images] Fixed broken link upload-URL.mdx”. Update the **Extended description** with more details about what you changed and why. The more details, the better.
40-
6. Select **Propose changes** > **Create pull request** > **Create pull request** again.
37+
2. In the [Cloudflare Docs](https://developers.cloudflare.com/), go to the page that you want to edit and select **Edit** in the right sidebar. ![Edit icon](~/assets/images/style-guide/ui-elements/edit.png) The first time you create a pull request in the cloudflare-docs repo, you will see a GitHub landing page that says "You need to fork this repository to propose changes."
38+
3. If you see this prompt, select **Fork this repository**. After you create the fork, all future pull requests for cloudflare-docs will write to a new branch in your fork. The page's markdown displays.
39+
4. Make your edits and select **Commit changes**.
40+
5. In the form, update the **Commit message** with the product you changed in brackets and a brief description of your changes. For example “[Images] Fixed broken link upload-URL.mdx."
41+
6. Update the **Extended description** with more details about what you changed and why. The more details, the better.
42+
7. Select **Propose changes** > **Create pull request** > **Create pull request** again.
4143
</Steps>
4244

4345
### Create with Codespace
4446
To create a GitHub pull request using the create with Codespace method:
4547
<Steps>
4648
1. [Log in to GitHub](http://github.com/login) and go to the [cloudflare-docs repo](https://github.com/cloudflare/cloudflare-docs).
47-
2. Select the **Code** dropdown > **Codespaces** tab > **Create codespace on production**.
48-
3. Codespace will open on the main “production” branch. Make sure you are on the latest version of production. To do so, select the **Source Control** icon in the sidebar > the ellipsis next to **Changes** > **Pull**.
49-
4. Do not make your edits on the main “production” branch. Instead, select the current branch (in this case, “production”) from the bar on the bottom of the window, type a name for your branch, and then select **Create new branch**.
50-
5. Select the **Explorer** icon in the left sidebar (it looks like two files) and then **src** > **content** > **docs** > and find the mdx file of the doc you want to edit in the file structure. If you want to edit a product Overview doc, you would edit the index.mdx inside of the product folder.
51-
6. You will see the markdown of the doc. Make your edits.
52-
7. To preview your changes, type `npm run dev` into the Codespace terminal. You might be prompted to install [Astro](https://astro.build/) or `npm`. If you experience errors, try using the `npm i` command to install `npm`. A link will appear in the terminal, `http://localhost:1111/`, which will bring you to a version of the Cloudflare Docs where you can find and preview how your changes will look. This link automatically updates with any new changes you make as you edit.
53-
8. Stage your changes by selecting **Source Control** in the left sidebar and then selecting the plus sign next to the file name under **Changes**.
54-
9. Commit your changes by entering a commit message in the form that briefly describes your changes, and then selecting **Commit** > **Publish Branch** > **origin**.
55-
10. Return to GitHub and select **Compare & pull request** next to your pull request.
56-
11. Update the title with the product you changed in brackets and a brief description of your changes. For example “[Images] Fixed broken link upload-URL.mdx”. For the description, add more details about what you changed and why. The more details, the better.
57-
12. Select **Create pull request**.
49+
2. Select the **Code** dropdown > **Codespaces** tab > **Create codespace on production**. Codespace will open on the main `production` branch.
50+
3. Make sure you are on the latest version of production. To do so, select the **Source Control** icon in the sidebar > the ellipsis next to **Changes** > **Pull**.
51+
4. Do not make your edits on the main `production` branch. Instead, select the current branch (in this case, `production`) from the bar on the bottom of the window, type a name for your branch, and then select **Create new branch**.
52+
5. Select the explorer icon in the left sidebar.
53+
6. Go to **src** > **content** > **docs** > and to locate and select the mdx file you want to edit. The page's markdown displays.
54+
7. Make your edits.
55+
8. To preview your changes, type `npm run dev` into the Codespace terminal. You might be prompted to install [Astro](https://astro.build/) or `npm`. If you experience errors, try using the `npm i` command to install `npm`. A link will appear in the terminal, `http://localhost:1111/`, where you can preview your changes. This link automatically updates with any new edits you make.
56+
9. To stage your changes, select **Source Control** in the left sidebar and select the plus sign next to the file name under **Changes**.
57+
10. To commit your changes, enter a commit message in the text field that briefly describes your changes, and then select **Commit** > **Publish Branch** > **origin**.
58+
11. Return to GitHub and select **Compare & pull request** next to your pull request.
59+
12. Update the title with the product you changed in brackets and a brief description of your changes. For example, “[Images] Fixed broken link upload-URL.mdx. For the description, add more details about what you changed and why. The more details, the better.
60+
13. Select **Create pull request**.
5861
</Steps>
5962
[Learn more about GitHub Codespaces.](https://docs.github.com/en/codespaces/quickstart)
6063

@@ -71,7 +74,15 @@ To create a GitHub pull request using the edit locally method, first setup the f
7174
```
7275
In addition to your project dependencies, a file called `package-lock.json` is also generated, which ensures that everyone uses the exact same dependency versions. Be sure to commit `package-lock.json` to git whenever it changes.
7376

74-
After setup, you will follow the same process as the **[create with Codespace method](#create-with-codespace)**: pull production > create a new branch > stage, commit, and publish changes > create your pull request on GitHub.
77+
After setup, follow the same process as the **[create with Codespace method](#create-with-codespace)**:
78+
<Steps>
79+
1. Pull production
80+
2. Create a new branch
81+
3. Stage your changes
82+
4. Commit your changes
83+
5. Publish the changes
84+
6. Create your pull request on GitHub
85+
</Steps>
7586

7687
## After you create an issue or PR
7788
After you open an issue or PR, a member of the Cloudflare organization will review your suggestion. Here is what to expect:

0 commit comments

Comments
 (0)