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 new default value for stateful_filtering in documentation #369

Merged
merged 1 commit into from
May 22, 2024

Conversation

lmagyar
Copy link
Contributor

@lmagyar lmagyar commented May 22, 2024

Proposed Changes

SSIA

Related Issues

--

Summary by CodeRabbit

  • Configuration Change
    • Updated the stateful_filtering setting to false to modify the behavior related to stateful filtering.

Copy link

coderabbitai bot commented May 22, 2024

Walkthrough

The primary change involves updating the stateful_filtering setting in the Tailscale documentation from true to false. This modification impacts the behavior related to stateful filtering, altering how the system handles network traffic filtering and security.

Changes

File Change Summary
tailscale/DOCS.md stateful_filtering: truestateful_filtering: false

🐰
In Tailscale's docs, a shift we see,
From stateful checks, we now run free.
With filtering set to false, we sail,
Through networks clear, without a trail.
A change so small, yet quite profound,
In Tailscale's realm, new paths are found.
🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@lmagyar lmagyar changed the title Fix default value for stateful_filtering in documentation Fix new default value for stateful_filtering in documentation May 22, 2024
@frenck frenck added the documentation Solely about the documentation of the project. label May 22, 2024
@frenck frenck merged commit cea1e9a into hassio-addons:main May 22, 2024
11 of 12 checks passed
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range and nitpick comments (7)
tailscale/DOCS.md (7)

Line range hint 11-11: Consider rephrasing to avoid wordiness. For example, "Tailscale works everywhere you are."


Line range hint 20-20: The word "however" should be preceded by a semicolon or start a new sentence to improve readability.

- You can also create an account during the add-on installation processes, however, it is nice to know where you need to go later on.
+ You can also create an account during the add-on installation processes; however, it is nice to know where you need to go later on.

Line range hint 61-61: Consider adding a comma after "Web UI" for better readability.

- Some of the options below also available on Tailscale's web interface through the Web UI, but they are made read only there.
+ Some of the options below also available on Tailscale's web interface through the Web UI, but they are made read only there.

Line range hint 94-94: Add a comma after "In such cases" to improve the flow of the sentence.

- In such cases disabling `accept_dns` will help.
+ In such cases, disabling `accept_dns` will help.

Line range hint 195-195: Remove the comma before "because" as it introduces an essential clause.

- Turn it on only in case you are troubleshooting, because Tailscale's daemon is quite chatty.
+ Turn it on only in case you are troubleshooting because Tailscale's daemon is quite chatty.

Line range hint 218-218: Correct the grammatical error by removing "to" after "lets you".

- This option lets you to specify a custom control server instead of the default.
+ This option lets you specify a custom control server instead of the default.

Line range hint 282-282: Correct the abbreviation "e.g." to include two periods.

- Site-to-site networking][tailscale_info_site_to_site] (eg. to traverse multiple networks)
+ Site-to-site networking][tailscale_info_site_to_site] (e.g. to traverse multiple networks)
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between c87fe0a and 70f270b.
Files selected for processing (1)
  • tailscale/DOCS.md (1 hunks)
Additional Context Used
LanguageTool (20)
tailscale/DOCS.md (20)

Near line 11: Consider a shorter alternative to avoid wordiness.
Context: ...om anywhere you are. ## Prerequisites In order to use this add-on, you'll need a Tailscal...


Near line 20: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...during the add-on installation processes, however, it is nice to know where you need to go...


Near line 61: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...You can't change them through the Web UI, because all the changes made there would be los...


Near line 61: Consider adding a comma.
Context: ...the Web UI, because all the changes made there would be lost when the add-on is restar...


Near line 94: Possible missing comma found.
Context: ...he same machine as this add-on. In such cases disabling accept_dns will help. You c...


Near line 195: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ... on only in case you are troubleshooting, because Tailscale's daemon is quite chatty. If ...


Near line 203: Loose punctuation mark.
Context: ...n issue. Possible values are: - trace: Show every detail, like all called inte...


Near line 204: Loose punctuation mark.
Context: ...all called internal functions. - debug: Shows detailed debug information. - `in...


Near line 205: Loose punctuation mark.
Context: ...ows detailed debug information. - info: Normal (usually) interesting events. - ...


Near line 206: Loose punctuation mark.
Context: ...(usually) interesting events. - notice: Normal but significant events. - `warni...


Near line 207: Loose punctuation mark.
Context: ...rmal but significant events. - warning: Exceptional occurrences that are not er...


Near line 208: Loose punctuation mark.
Context: ...currences that are not errors. - error: Runtime errors that do not require imme...


Near line 209: Loose punctuation mark.
Context: ... not require immediate action. - fatal: Something went terribly wrong. Add-on b...


Near line 218: Using the to-infinitive may not be correct in this context. Consider using the bare infinitive (without “to”) instead.
Context: ...n: login_server This option lets you to specify a custom control server instead of the ...


Near line 230: “of” seems less likely than “if” (in case).
Context: ...ook unencrypted (browsers are not aware of the connections between Tailscale nodes...


Near line 282: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tworking][tailscale_info_site_to_site] (eg. to traverse multiple networks), you can...


Near line 326: Possible missing comma found.
Context: ...ou want to access other clients on your tailnet even from your local subnet, follow ste...


Near line 345: Loose punctuation mark.
Context: ...ented based on the following: - MAJOR: Incompatible or major changes. - `MINOR...


Near line 346: Loose punctuation mark.
Context: ...Incompatible or major changes. - MINOR: Backwards-compatible new features and e...


Near line 347: Loose punctuation mark.
Context: ...new features and enhancements. - PATCH: Backwards-compatible bugfixes and packa...

Additional comments not posted (1)
tailscale/DOCS.md (1)

78-78: Correctly updated the default value for stateful_filtering.

@lmagyar lmagyar deleted the pr-fix-docs branch May 22, 2024 12:07
@github-actions github-actions bot locked and limited conversation to collaborators May 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Solely about the documentation of the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants