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

ufw: Added an example of rule comments #1519

Merged
merged 2 commits into from
Oct 7, 2017
Merged

Conversation

kalebo
Copy link
Contributor

@kalebo kalebo commented Oct 5, 2017

One of the more obscure features of UFW is being able to add comments to your rules and was only added last year. This feature helps significantly when managing a complicated rule set.

I tried to shim it in to an existing example without introducing too much complexity as the entry already has eight examples.


  • The page (if new), does not already exist in the repo.

  • The page (if new), has been added to the correct platform folder:
    common/ if it's common to all platforms, linux/ if it's Linux-specific, and so on.

  • The page has 8 or fewer examples.

  • The PR is appropriately titled:
    <command name>: add page for new pages, or <command name>: <description of changes> for pages being edited

  • The page follows the contributing guidelines

@@ -15,9 +15,9 @@

`ufw status numbered`

- Allow incoming traffic on port 5432 on this host:
- Allow incoming traffic on port 5432 on this host and an identifing comment:
Copy link
Member

Choose a reason for hiding this comment

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

typo => identifing

And I recommend using "with an" instead of "and an" to signify that this comment is paired with that rule.

@agnivade agnivade added the page edit Changes to an existing page(s). label Oct 6, 2017
@sbrl sbrl merged commit 8cc04a9 into tldr-pages:master Oct 7, 2017
@sbrl
Copy link
Member

sbrl commented Oct 7, 2017

Looks good to me 😺

@kalebo kalebo deleted the patch-5 branch October 9, 2017 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
page edit Changes to an existing page(s).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants