Restructure headscale documentation #2163
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nblock
requested review from
ohdearaugustin,
juanfont and
kradalby
as code owners
kradalby
approved these changes
Oct 9, 2024
* Move existing Client OS support table into its own documentation page * Link from README.md to the rendered documentation * Document minimum Tailscale client version
* Include "CONTRIBUTING.md" from the repository root * Update FAQ and index page and link to the contributing docs
* Use the existing "Using headscale" sections and combine them into a single getting started guide with a little bit more explanation. * Explain how to get help from the command line client. * Remove duplicated sections from existing installation guides
Use the term headscale for the project, Headscale on the beginning of a sentence and `headscale` when refering to the CLI.
Also update ignored files for prettier
thx @efficacy38 for noticing this Ref: juanfont#1863
kradalby
reviewed
Oct 9, 2024
|
I'm very happy with this, I will let the tests run and then roll out tomorrow unless you have any other things you think should be part of it @nblock |
I'm happy with it for now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following the spirit of the 0.23 release, this PR aims to restructure the existing documentation to improve
maintanability while providing more information to users. It is mainly a preparation for versioned documentation in the
future which will allow us to evolve the documentation alongside headscale releases. Relevant aspects of this PR:
headscalewhen referring to the CLI.A preview is available here: https://nblock.github.io/headscale/
Fixes: #2164
Ref: #1863