Skip to content

Commit 5ae5bec

Browse files
committed
Fix broken links
Signed-off-by: Pavithra Eswaramoorthy <[email protected]>
1 parent 0705866 commit 5ae5bec

File tree

5 files changed

+33
-20
lines changed

5 files changed

+33
-20
lines changed

docs/community/issues.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ If an issue is affecting you, start at the top of this list and complete as many
4747

4848
1. Check the [issue tracker][nebari-issues], if there is an open issue for this same problem, add a reaction or more details to the issue
4949
to indicate that it’s affecting you (tip: make sure to also check the open [pull requests][nebari-prs] for ongoing work).
50-
2. You should also check the [troubleshooting guide](../troubleshooting.mdx) in these docs to see if your problem is already listed there.
50+
2. You should also check the [troubleshooting guide][troubleshooting] in these docs to see if your problem is already listed there.
5151
3. If there is an open issue, and you can add more detail, write a comment describing how the problem is affecting you,
5252
OR if you can, write up a work-around or improvement for the issue.
5353
4. If there is not an issue, write the most complete description of what’s happening including reproduction steps.
5454
5. [Optional] - Offer to help fix the issue (and it is totally expected that you ask for help; open-source maintainers want to help contributors).
5555
<!-- 6. TODO link to the PR section of the docs -->
56-
6. If you decide to help to fix the issue, deliver a well-crafted, tested PR.
56+
1. If you decide to help to fix the issue, deliver a well-crafted, tested PR.
5757

5858
## Working on issues to improve them
5959

@@ -66,7 +66,11 @@ The following actions are typically useful:
6666
- Linking to related issues or discussions while briefly describing how they are related, for instance “See also #xyz for a similar attempt at this” or “See also #xyz where the same thing happened in another cloud provider" provides context and helps the discussion.
6767
- Summarizing long discussions on issues to help new and existing contributors quickly understand the background, current status, and course of action for the issue.
6868

69-
<!-- links -->
69+
<!-- Internal links -->
70+
71+
[troubleshooting]: /docs/troubleshooting.mdx
72+
73+
<!-- External Links -->
7074

7175
[nebari-issues]: https://github.com/nebari-dev/nebari/issues
7276
[nebari-labels]: https://github.com/nebari-dev/nebari/labels

docs/community/maintainers/triage-guidelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,5 +129,5 @@ Support requests should be directed to the following channels:
129129

130130
[code-contributions]: community/code-contributions.mdx
131131
[github-conventions]: community/maintainers/github-conventions.md
132-
[troubleshooting]: ../../troubleshooting.mdx
133-
[saved-replies]: ./saved-replies.md
132+
[troubleshooting]: docs/troubleshooting.mdx
133+
[saved-replies]: community/maintainers/saved-replies.md

docs/community/nebari-tests.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This page has some tips for testing your contributions to make sure it works as
1111

1212
### Test CLI manually
1313

14-
If you have an [editable installation of Nebari](code-contributions#install-nebari-in-editable-mode), you can test your changes by running the [Nebari CLI commands](../get-started/quickstart) from within your development environment.
14+
If you have an [editable installation of Nebari](code-contributions#install-nebari-in-editable-mode), you can test your changes by running the [Nebari CLI commands][quickstart] from within your development environment.
1515
For example, you can run `nebari init` and make sure it builds the `nebari-config.yaml` file without errors.
1616

1717
### Test CLI with `pytest`
@@ -80,7 +80,7 @@ It can help you review and resolve day-to-day issues in the deployed clusters qu
8080

8181
You can install `k9s` on macOS, Windows, and Linux with [these instructions project's README](https://github.com/derailed/k9s).
8282

83-
For more details on using `k9s`, check out the [documentation on debugging Nebari](../how-tos/debug-nebari#debugging-the-kubernetes-cluster-using-k9s).
83+
For more details on using `k9s`, check out the [documentation on debugging Nebari][debugging-nebari].
8484

8585
### Cloud testing
8686

@@ -233,3 +233,8 @@ To get around this, set the `NEBARI_K8S_VERSION` environment variable with:
233233
```bash
234234
export NEBARI_K8S_VERSION=1.20
235235
```
236+
237+
<!-- Internal links -->
238+
239+
[quickstart]: docs/get-started/quickstart
240+
[debugging-nebari]: docs/how-tos/debug-nebari#debugging-the-kubernetes-cluster-using-k9s

docs/community/style-guide.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Follow your best judgment, and feel free to add to this document following our c
3030
- **Avoid abbreviations** like "e.g.", "i.e.", and "etc.". Use full words like "for example", "that is", and "and so on" respectively.
3131
- Use **serial commas**, also known as Oxford comma. For example: "Nebari brand uses purple, yellow, and green."
3232
- Leave **only one blank space between sentences**.
33-
- **Break up long lines in code snippets** with "`\`" for better readability. For example, see the code block in [Automatic DNS provision](../how-tos/domain-registry#automatic-dns-provision).
33+
- **Break up long lines in code snippets** with "`\`" for better readability. For example, see the code block in [Automatic DNS provision][automatic-dns-provision].
3434
- Try and **use [semantic line breaks](https://sembr.org/)** to help with documentation and contribution reviews.
3535
- **Prefer American English** over British or other English variant to keep spelling consistency.
3636

@@ -99,3 +99,7 @@ For example: "To start JupyterLab, you run `jupyter lab`."
9999
- The [Microsoft Writing Style Guide](https://learn.microsoft.com/en-gb/style-guide/welcome/) is also a very thorough style guide. The included A-Z word list is a handy reference if you're unsure about a specific term.
100100
- [Digital Ocean's tutorial style guide](https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines).
101101
- [Write the Docs collection of resources for accessible writing](https://www.writethedocs.org/guide/writing/accessibility/).
102+
103+
<!-- Internal links -->
104+
105+
[automatic-dns-provision]: docs/how-tos/domain-registry#automatic-dns-provision

docs/docs/welcome.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -150,9 +150,9 @@ Learn to perform specific tasks in Nebari, with step-by-step instructions.
150150

151151
Nebari is a community-led open source project, learn how you can get involved!
152152

153-
> [Facing issues with Nebari? Get support on GitHub discussions or the issue tracker →](./community#getting-support)
153+
> [Facing issues with Nebari? Get support on GitHub discussions or the issue tracker →](docs/community#getting-support)
154154
155-
> [Learn how you can contribute to Nebari, beyond code and pull-requests →](./community#how-to-contribute)
155+
> [Learn how you can contribute to Nebari, beyond code and pull-requests →](docs/community#how-to-contribute)
156156
157157
[↳ Read all community resources][community]
158158

@@ -180,13 +180,13 @@ Understand technical details of Nebari's architecture and how it works.
180180
<!-- Internal links -->
181181

182182
[nebari-home]: https://nebari.dev/
183-
[get-started]: ./category/get-started
184-
[tutorials]: ./tutorials/
185-
[how-tos]: ./how-tos/
186-
[community]: ./community/
187-
[references]: ./references
188-
[release-notes]: ./references/RELEASE
189-
[using-dask]: ./tutorials/using_dask
190-
[using-vscode]: ./how-tos/using-vscode
191-
[configure-keycloak]: ./how-tos/configuring-keycloak
192-
[create-dashboards]: ./tutorials/create-dashboard
183+
[get-started]: docs/get-started/
184+
[tutorials]: docs/tutorials/
185+
[how-tos]: docs/how-tos/
186+
[community]: community/
187+
[references]: docs/references
188+
[release-notes]: docs/references/RELEASE
189+
[using-dask]: docs/tutorials/using_dask
190+
[using-vscode]: docs/how-tos/using-vscode
191+
[configure-keycloak]: docs/how-tos/configuring-keycloak
192+
[create-dashboards]: docs/tutorials/create-dashboard

0 commit comments

Comments
 (0)