docs: make hardening channel access section channel-agnostic#32
Merged
Conversation
Rename the Slack-specific 'Slack Channel Restrictions' section to 'Channel Access Restrictions'. Explain the four access controls (channel allowlist, user allowlist, DMs, per-channel audiences) as channel-agnostic concepts and drop the duplicated Slack JSON examples. Add an index table linking to each channel's own Access control section, so per-channel setup details live on the channel pages and the index grows as new channels ship. Note that webhooks authenticate via HMAC rather than allowlists, and remove the Slack-specific ID lookup link from Further Reading. Closes #26
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Reworks the channel access section of the Hardening docs so it stops being Slack-prescriptive.
## Slack Channel Restrictions->## Channel Access Restrictions.Access controlsections./channels/slack/#access-control,/channels/discord/#access-control), with a maintainer comment to add a row as new channels ship.The
netclaw doctorreference stays scoped to Slack —SlackAclDoctorCheckis the only channel ACL check that exists.Why
The section duplicated content already on the channel pages and read as Slack-only. An index that points to per-channel pages is easier to keep correct as channel support grows.
Closes #26.
Verification
npm run buildpasses (55 pages).