Skip to content

Commit 60820d9

Browse files
authored
improve content and readability (#6355)
1 parent 85c5285 commit 60820d9

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

CONTRIBUTING-TECHNICAL-GUIDE.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,34 @@ GH provides great DX for making updates, committing and creating PRs via the bro
1414
Use GitHub GUI browser when you:
1515
- Have simple and only a few edits of the markdown files.
1616
- Already know the syntax for adding internal links and adding images.
17-
- Already know what you are going to write and you **don't** need many iterative commits to see if the result looks okay. In this case, using a local environment will be much faster (explain in the next section)
17+
- Already know what you are going to write and you **don't** need many iterative commits to see if the result looks okay. In this case, using a local environment will be much faster as explained in the next section.
1818

1919
#### How To Use It?
20-
Will briefly explain it as it is quite trivial:
20+
I'll briefly explain the process as it is quite straightforward:
2121
1. Via the GUI you can simply click the pencil icon to start editing, then check the differences, click commit to commit the changes to a new branch, and eventually create a PR.
2222
2. Check that the CI jobs started running. These jobs run tests on the website including your changes. Running CI jobs are displayed in yellow.
2323
3. Once the CI job finishes it will turn green. Upon completion, you will see a preview link that you should use to check your changes on a real deployment of the Tyk docs website.
2424

2525

2626
### 2. Local Development Environment
27-
Local environment means, checking out the tyk-docs repo and updating the files using an editor or an IDE. This allows you to test the changes by running Hugo locally and check for errors in Hugo or in the website Hugo generated.
27+
Local environment means checking out the tyk-docs repo and updating the files using an editor or an IDE. This allows you to test your changes by running Hugo locally and check for errors both in the Hugo process and in the website that Hugo generates.
2828

2929
#### When To Use It?
3030
Using the browser is not always enough and you sometimes need to check out the repo and work locally.
3131
You normally favor using a local environment when you need to:
32-
- Test things yourself before you push them
33-
- Repeatedly push changes and test the website
32+
- Test your changes in real-time before pushing them
33+
- Repeatedly make changes and test the website
3434

35-
Doing so by **running Hugo locally will save you a lot of time** since it takes the CI a few minutes to update the deployment with the latest changes and finish its test before it becomes green.
35+
Doing so by **running Hugo locally will save you a lot of time** since it takes the CI a few minutes to update the deployment with the latest changes and complete its tests before showing a green success status.
3636

3737
#### Use Cases For Local Development Environment
3838
When you need to:
39-
- Test things yourself before you push them
40-
- Check that the image you added work
39+
- Preview changes and verify their appearance locally
40+
- Check that the images you added work correctly
4141
- See how images are rendered on the page
4242
- Check that the internal links you added work
43-
- Are not sure about the syntax of links or images when you work on many pages
44-
- When adding new files, it's easier to run it locally since you cannot be sure of the internal links format and may need to validate referenced links to other content pages and sections
43+
- When you are not sure about the syntax of links or images when working on many pages
44+
- When adding new files, it's easier to run Hugo locally because you need to validate the format of internal links and references to other content pages and sections
4545

4646
#### How To Use It?
4747

@@ -415,13 +415,15 @@ You can also specify a class or custom styling:
415415
### Feature Name {{< pill-label text="LABEL" style="background-color: #f0f0f0; color: #333;" >}}
416416
```
417417

418-
For detailed examples and all available styling options, see the [pill-label examples page](content/ui-examples/test-pill-label.md). You can run Hugo locally to see how the pill labels appear in your browser:
418+
To read and view detailed examples of all the available styling options, see the [pill-label live examples page](https://tyk.io/docs/ui-examples/test-pill-label/)
419+
420+
There's also a [security pill-label test file](./tyk-docs/tyk-docs/content/ui-examples/test-pill-label-security.md) to validate the security of the implementation. It's in a draft mode, so if you want to see it in the website, you need to run Hugo with `--buildDrafts` as follows
419421

420422
```
421-
hugo server --theme=tykio --buildDrafts --enableGitInfo
423+
hugo server --theme=tykio --buildDrafts --enableGitInfo --port 1313
422424
```
423425

424-
Then navigate to `http://localhost:1313/docs/nightly/ui-examples/test-pill-label/` to view the examples.
426+
Then navigate to `http://localhost:1313/docs/nightly/ui-examples/test-pill-label-security/` to view the examples.
425427

426428
## License
427429

0 commit comments

Comments
 (0)