Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite main documentation #262

Merged
merged 19 commits into from
Jan 4, 2022
Merged

Rewrite main documentation #262

merged 19 commits into from
Jan 4, 2022

Conversation

kradalby
Copy link
Collaborator

@kradalby kradalby commented Jan 2, 2022

This commit starts restructuring the documentation and updating it to be
compliant with 0.12.x+ releases.

The main change is that the documentation has been rewritten for the
ground up, and hopefully simplified.

The documentation has been split into an official documentation for
running headscale as a binary under Linux with SystemD and a "community"
provided documentation for Docker.

This should make the two documents a lot easier to read and follow than
the mishmash documentation we had.

@cure @ohdearaugustin @juanfont

This commit starts restructuring the documentation and updating it to be
compliant with 0.12.x+ releases.

The main change is that the documentation has been rewritten for the
ground up, and hopefully simplified.

The documentation has been split into an official documentation for
running headscale as a binary under Linux with SystemD and a "community"
provided documentation for Docker.

This should make the two documents a lot easier to read and follow than
the mishmash document we had.
@kradalby kradalby requested review from cure and juanfont January 2, 2022 19:09
@@ -66,7 +68,7 @@ tasks like creating namespaces, authkeys, etc.

headscale is an open source implementation of the Tailscale control server

https://gitlab.com/juanfont/headscale
https://github.com/juanfont/headscale
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well spotted!

@kradalby kradalby marked this pull request as ready for review January 4, 2022 16:26
@kradalby kradalby merged commit 42bed58 into juanfont:main Jan 4, 2022
@kradalby kradalby deleted the improve-docs branch January 4, 2022 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants