|
1 | 1 | # Contribute to Temporal Documentation Locally |
2 | 2 |
|
3 | | -1. **Clone the Repository** |
| 3 | +1. **Fork the Repository** |
| 4 | + Create a fork of this repository. |
| 5 | + *This creates a copy of this repository to your github account* |
| 6 | + |
| 7 | +2. **Clone the Repository** |
4 | 8 | Run the following commands in your terminal to clone the repository and navigate into it: |
5 | 9 | ```bash |
6 | 10 | git clone https://github.com/YOUR_USERNAME/documentation.git |
7 | 11 | cd documentation |
8 | 12 | ``` |
9 | 13 |
|
10 | | -2. **Open the Repository in Your IDE** |
| 14 | +3. **Open the Repository in Your IDE** |
11 | 15 | Open the project in your preferred IDE, such as Visual Studio Code. Locate the `/docs` directory, which contains all the content served on `docs.temporal.io`. Identify the changes you want to make. |
12 | 16 |
|
13 | | -3. **Create a New Branch** |
| 17 | +4. **Create a New Branch** |
14 | 18 | If you're creating a pull request, create a new branch and switch to it: |
15 | 19 | ```bash |
16 | 20 | git checkout -b my-documentation-contribution |
17 | 21 | ``` |
18 | 22 |
|
19 | | -4. **Follow the Style Guide** |
| 23 | +5. **Follow the Style Guide** |
20 | 24 | Refer to [STYLE.md](./STYLE.md) for the documentation style guidelines. |
21 | 25 |
|
22 | | -5. **Preview Your Changes Locally** |
| 26 | +6. **Preview Your Changes Locally** |
23 | 27 | Run the following commands to preview the site locally: |
24 | 28 | ```bash |
25 | 29 | yarn # Install site dependencies |
26 | 30 | yarn start # Start the website on a local port |
27 | 31 | yarn build # Check for build warnings or errors |
28 | 32 | ``` |
29 | 33 |
|
30 | | -6. **Stage Your Changes** |
| 34 | +7. **Stage Your Changes** |
31 | 35 | Use the following commands to stage and commit your changes: |
32 | 36 | ```bash |
33 | 37 | git status # Check the status of your changes |
|
36 | 40 | git push origin my-documentation-contribution # Push changes |
37 | 41 | ``` |
38 | 42 |
|
39 | | -7. **Create a Pull Request** |
| 43 | +8. **Create a Pull Request** |
40 | 44 | - After pushing, GitHub provides a link in the terminal to create a PR. Open the link or navigate to your fork on GitHub. |
41 | 45 | - Click the option to create a Pull Request (PR). |
42 | 46 | - Provide a descriptive PR title and explanation. |
|
0 commit comments