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

fix(docs): migrating tailscale acl notes to provisioner repo #110

Conversation

venkatamutyala
Copy link
Contributor

@venkatamutyala venkatamutyala commented Dec 16, 2024

PR Type

Documentation


Description

  • Removed detailed Tailscale ACL configuration documentation from the main README file
  • The removed section included:
    • ACL policy examples for provisioner API and nodes communication
    • SSH access configuration settings
    • Tag ownership and group permissions examples
  • This content is being migrated to the provisioner repository for better organization

Changes walkthrough 📝

Relevant files
Documentation
README.md
Remove Tailscale ACL documentation from README                     

README.md

  • Removed Tailscale ACL configuration section from the README
  • Removed example JSON configuration for ACL policies
  • Removed documentation about SSH access and tag ownership settings
  • +0/-107 

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Add a reference to relocated security documentation to maintain documentation completeness

    Add a reference link to where the Tailscale ACL configuration documentation has been
    migrated to ensure users can still find this critical security information.

    README.md [118-120]

     6. Generate an API acess token: you will need to give it a description. The key must be rotated and has a max expiration of 90 days, but can be shortened. This will be your Tailscale api token.
    +
    +For Tailscale ACL configuration details, please refer to the provisioner repository documentation at [link].
     
     # Adding Bot commands
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Adding a reference link to the relocated ACL documentation is important for maintaining continuity and ensuring users can still access critical security configuration information after its removal from this README.

    7

    @venkatamutyala venkatamutyala deleted the fix(docs)-migrating-tailscale-acl-notes-to-provisioner-repo branch December 16, 2024 18:18
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant