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

Add documentation for the Tailscale service #458 #459

Conversation

FroggyFlox
Copy link
Member

Fixes #458
@phillxnet, @Hooverdan96: ready for review.

This pull request's proposal

This pull-request adds a basic documentation on the Tailscale service:

  • configuration options
  • important requirements
  • how to login/authenticate
  • what to expect on the created networks

This commit also includes a fix for Sphinx's basic css theme that was not properly loaded as we expect. This corrects all images that weren't actually aligned even though they were defined to be.

Finally, the entire services.rst was reformatted (including minor typo corrections) in an effort to follow semantic linefeeds.

Checklist

  • With the proposed changes no Sphinx errors or warnings are generated.
  • I have added my name to the AUTHORS file, if required (descending alphabetical order).

This commit adds basic documentation on the Tailscale service:
  - configuration options
  - important requirements
  - how to login/authenticate
  - what to expect on the created networks

 This commit also includes a fix for Sphinx's basic css theme that
 was not properly loaded as we expect. This corrects all images
 that weren't actually aligned even though they were defined to be.
Copy link
Member

@phillxnet phillxnet left a comment

Choose a reason for hiding this comment

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

@FroggyFlox this is some fast follow-up with docs. Much appreciated.

And thanks for the semantic line-feed formatting. But remember we can break on commas also, To avoid some way-long lines.

Merging as looks good and would be great to have this out to accompany our recent addition of this key service.

Well done on the formatting fix re image centre.

The Tailscale write up is nicely done. Thanks for taking care to communicate all this. Again much appreciated.

@phillxnet
Copy link
Member

phillxnet commented Oct 20, 2023

@FroggyFlox Curiously the linkcheck here (run within buildbot) passed without issue.

Link check complete; look for any errors in the above output  or in _build/linkcheck/output.txt.
program finished with exit code 0

So it looks like a timeout on this url:

(interface/overview: line  197) broken    https://www.minecraft.net/en-us/ - HTTPSConnectionPool(host='www.minecraft.net', port=443): Read timed out. (read timeout=20)

@phillxnet phillxnet merged commit acf21c7 into rockstor:master Oct 20, 2023
2 of 3 checks passed
@phillxnet
Copy link
Member

PR product PRODUCTION published.

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.

Add documentation for Tailscale service
2 participants