Skip to content

docs: add organization profile README - #1

Open
HighnessAtharva wants to merge 2 commits into
mainfrom
docs/org-profile-readme
Open

docs: add organization profile README#1
HighnessAtharva wants to merge 2 commits into
mainfrom
docs/org-profile-readme

Conversation

@HighnessAtharva

Copy link
Copy Markdown
Member

Why

GitHub renders profile/README.md from this repository at the top of https://github.com/kubearmor. Until now the org page showed only a repository list, so a first-time visitor had no front door and no idea which of ~40 repositories to open.

What it does

The page answers three questions and then gets out of the way: what the project is, whether it is alive, where to start. It deliberately does not repeat the main repository README.

Section Content
Header Logo, one-line description, CNCF Sandbox line, five nav links.
What KubeArmor does Two paragraphs. The second one is the whole pitch: others react after the code runs, KubeArmor decides in the kernel before it. Carries the inline-enforcement figure.
Start here Six intents, each routed to exactly one link, plus the Helm install snippet.
Repositories worth knowing The six a newcomer needs, out of roughly 40.
Where it runs Managed Kubernetes, self-managed, VMs, IoT and edge, hardened distros.
Community and governance Governance, Maintainers, Code of Conduct, releases, security policy, community call, Slack.

Notes for reviewers

  1. The figure is hot-linked to raw.githubusercontent.com on kubearmor/KubeArmor@main. An org profile README cannot use a relative path into another repository. It renders once kubearmor/KubeArmor#2840 merges, since that PR adds the SVG. If you would rather not couple the two repositories, I will copy the SVG into this repository and point at it locally.
  2. No star counts, download totals, or Slack member numbers. Those age badly on a static page. If you want them, they should be self-updating badges, not text.
  3. Logo is the light-background SVG from kubearmor.io. If you want it to adapt, say so and I will switch to a <picture> element with both variants.
  4. The base commit on main is empty. This repository had no commits, and a pull request needs a base that exists. main holds an empty initialisation commit only, so the entire README arrives through this PR for review.

Related

Repository README refresh: kubearmor/KubeArmor#2840.

🤖 Generated with Claude Code

HighnessAtharva and others added 2 commits August 14, 2026 18:32
GitHub renders profile/README.md on https://github.com/kubearmor, which
until now showed only a repository list. A first-time visitor had no
front door.

The page answers three questions and then gets out of the way: what the
project is, whether it is alive, and where to start. It does not repeat
the main repository README.

Contents:

- What KubeArmor does, with the inline enforcement figure from the
  KubeArmor repository.
- A "start here" table routing each intent to one link.
- The six repositories a new visitor needs, out of roughly 40.
- Where it runs, including hardened distributions.
- Governance, Code of Conduct, releases, security policy, community call.

Star counts and download totals are left out on purpose. They age badly
on a static page.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The copy read like generated text. Rewrite it to address the reader
directly, drop the sentence fragments used for rhythm, and fix the
figure alt text, which still described the detailed first-pass drawing.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@HighnessAtharva

Copy link
Copy Markdown
Member Author

Pushed 1c4aa36, matching kubearmor/KubeArmor#2840. The prose read like generated text, so I rewrote it to address the reader directly and dropped the sentence fragments that were there for rhythm. The figure alt text is also fixed, since it still described the detailed first-pass drawing rather than the simplified one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant