void-linux / void-linux/void-docs

config/network/firewall.md: needs some rework/clarifications.

Open
#512 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug enhancement help wanted
Dominant language
CSS
Stars
217
Forks
212
Avg merge
2d 21h
Merged PRs (30d)
1

Description

We currently have here two sections "Applying rules at boot" and "Applying rules at runtime" both are ambiguous.
Both of them work at boot and at runtime, they are two alternative methods, with the one "Applying rules at boot" being clearly the better solution because they don't need a fake service and they make sure firewall rules are loaded before network services are up.

  • Change the headlines for "Applying rules at X".
  • Make clear that they are two ways of loading rules at boot and at runtime, make clear that core-services/rc.local is superior.
  • Document how to reload rules with the fake service, sv can be used and with the better core-services or rc.local method the nftables (or iptables) command can be used.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open config/network/firewall.md and compare the sections currently titled "Applying rules at boot" and "Applying rules at runtime." Clarify that these are alternative ways to load rules at boot and runtime, explain why core-services/rc.local is preferred, and document reloading with sv or the nftables/iptables command; the updated section headings and instructions should remove the ambiguity.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.