Skip to content

Commit f278718

Browse files
authored
feat: Update PR links to GitHub URLs, fix inline Tutorial guidance (#193)
This commit updates the links from the PR templates to use the actual GitHub links: they are currently relative links that do not parse as intended, instead linking to parts of the GitHub website. It also fixes an issue in the Tutorial archetype's inline Markdown guidance caused by an unintentionally escaped quotation mark.
1 parent 93c775d commit f278718

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

.github/pull_request_template.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ Closes #ISSUE
2121

2222
Before merging a pull request, run through this checklist and mark each as complete.
2323

24-
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md)
24+
- [ ] I have read the [contributing guidelines](https://github.com/nginx/documentation/blob/main/CONTRIBUTING.md)
2525
- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)
26-
- [ ] I have ensured that documentation content adheres to [the style guide](/templates/style-guide.md)
26+
- [ ] I have ensured that documentation content adheres to [the style guide](https://github.com/nginx/documentation/blob/main/templates/style-guide.md)
2727
- [ ] If the change involves potentially sensitive changes, I have assessed the possible impact
2828
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
2929
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes
30-
- [ ] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md))
30+
- [ ] I have updated any relevant documentation ([`README.md`](https://github.com/nginx/documentation/blob/main/README.md) and [`CHANGELOG.md`](https://github.com/nginx/documentation/blob/main/CHANGELOG.md)
3131
- [ ] I have rebased my branch onto main
3232
- [ ] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork
3333

3434
Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation.
3535

36-
Please refer to [our style guide](/templates/style-guide.md) for guidance about placeholder content.
36+
Please refer to [our style guide](https://github.com/nginx/documentation/blob/main/templates/style-guide.md) for guidance about placeholder content.

archetypes/concept.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ It is an example of a <other concept>, and is closely related to <third concept>
3535

3636
## Use cases
3737

38-
[//]: # "Name the individual use case sections after the actual use case itself, e.g "Route traffic between applications"
38+
[//]: # "Name the individual use case sections after the actual use case itself, e.g 'Route traffic between applications'"
3939

4040
### Use case 1
4141

0 commit comments

Comments
 (0)