Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Docs: regroup architecture and remove stale identity text

Open
  • Is something wrong?
#444 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Read PLAN.md Phase 4 and resolve dependency #442 before starting. Review docs/architecture/identity-*.md, docs/architecture/diagrams/README.md, the architecture and guide pages, and navigation.yaml; preserve Keycloak references in ADR History footers. Finish when the identity classes and network policy/RBAC pages are present, navigation covers all pages, the specified grep finds no current-behaviour Keycloak text, and openlakeforge.dev builds with zero broken links.

Written by the indexing model from the issue text.

Description

documentation priority: P2

Part of the docs restructure for openlakeforge.dev (PLAN.md, Phase 4). Depends on #442.

Scope

  • Group docs/architecture/identity-*.md under docs/architecture/identity/, and add the identity classes page for #178 (human, in-cluster workload, cloud workload, and the mechanism that governs each).
  • Add a network policy and RBAC page for #46, including Dex egress to GitHub.
  • Move docs/architecture/diagrams/README.md to docs/architecture/diagrams.md; the chart sources stay where they are.
  • Remove stale Keycloak, olf users, invitation and SMTP text from architecture and guide pages; ADR History footers keep it as history.
  • Final navigation.yaml pass: every page sits under Get started, Tutorial, Guides, Reference, Architecture or Decisions.

Acceptance

  • git grep -i keycloak -- docs ':!docs/adr' returns nothing that describes current behaviour.
  • The #178 acceptance line "contract documentation states the three classes" is met.
  • openlakeforge.dev builds against this commit with zero broken links.

🤖 Generated with Claude Code

Dominant language
Python
Stars
26
Forks
6
Avg merge
12h 14m
Merged PRs (30d)
133

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from OpenLakeForge/openlakeforge

All issues in OpenLakeForge/openlakeforge

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.