Skip to content

Commit cb7ee1b

Browse files
committed
Make the contributing overview the index page
Also rename it to "Getting Started". Signed-off-by: Tom Wieczorek <[email protected]>
1 parent fc957d1 commit cb7ee1b

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# K0s Contributor Guide
22

3-
Please refer to our [contributor's guide](docs/contributors/overview.md).
3+
Please refer to our [Contributor Guide](docs/contributors/).

docs/contributors/overview.md renamed to docs/contributors/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to k0s
1+
# Getting Started
22

33
Thank you for taking the time to make a contribution to k0s. The following document is a set of guidelines and instructions for contributing to k0s.
44

@@ -8,14 +8,14 @@ When contributing to this repository, please consider first discussing the chang
88

99
Our code of conduct can be found in the link below. Please follow it in all your interactions with the project.
1010

11-
- [Code of Conduct](./CODE_OF_CONDUCT.md)
11+
- [Code of Conduct](CODE_OF_CONDUCT.md)
1212

1313
## GitHub Workflow
1414

1515
We use [GitHub flow], so all code changes are tracked via Pull Requests. A
1616
detailed guide on the recommended workflow can be found below:
1717

18-
- [GitHub Workflow](./github_workflow.md)
18+
- [GitHub Workflow](github_workflow.md)
1919

2020
[GitHub flow]: https://docs.github.com/get-started/quickstart/github-flow
2121

@@ -25,7 +25,7 @@ All submitted PRs go through a set of tests and reviews. You can run most of the
2525
In fact, we recommend it, because it will save on many possible review iterations and automated tests.
2626
The testing guidelines can be found here:
2727

28-
- [Contributor's Guide to Testing](./testing.md)
28+
- [Contributor's Guide to Testing](testing.md)
2929

3030
## License
3131

mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ nav:
7777
- Commercial support: commercial-support.md
7878
- Adopters: adopters.md
7979
- Contributing:
80-
- Overview: contributors/overview.md
80+
- Getting Started: contributors/index.md
8181
- GitHub Workflow: contributors/github_workflow.md
8282
- Testing: contributors/testing.md
8383
- Documentation: internal/publishing_docs_using_mkdocs.md

0 commit comments

Comments
 (0)