siderolabs / siderolabs/docs

Omni Docs - Consolidate and update AccessPolicies

Open
#173 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
MDX
Stars
11
Forks
76
Avg merge
3d 5h
Merged PRs (30d)
26

Description

When looking at the documentation for AccessPolicies there is two page with different content and only on of them is working as far as I can figure out.

This guide is working for me: https://docs.siderolabs.com/omni/security-and-authentication/how-to-manage-acls#create-an-accesspolicy-resource

This one is not: https://docs.siderolabs.com/omni/reference/acls

Contributor guide

No contributing guide indexed for this repository

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

Start by comparing the two entry points named in the issue: the working AccessPolicies guide under security-and-authentication and the broken reference/acls page. Trace where each page is maintained in the documentation repository, then consolidate the accurate content and verify that the resulting AccessPolicies documentation works and no longer conflicts.

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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.