Skip to content

docs: add org community-health files pointing at rossoctl/rossoctl - #129

Merged
mrsabath merged 1 commit into
mainfrom
docs/org-community-health-pointers
Oct 9, 2026
Merged

mrsabath merged 1 commit into
mainfrom
docs/org-community-health-pointers

Conversation

@mrsabath

@mrsabath mrsabath commented Oct 9, 2026 •

Copy link
Copy Markdown
Member

Summary

GitHub serves community-health files from a .github repository to every repo in the org that does not define its own. This repo had the issue templates and PR template, but none of the four documents — so nothing was being inherited.

Verified before writing anything:

$ gh api repos/rossoctl/moca/community/profile
code_of_conduct: null
security:        null

Adds the four as pointers, not copies, so rossoctl/rossoctl stays the single source of truth and these cannot drift from it:

File Points at Also carries
CODE_OF_CONDUCT.md org policy where conduct reports go
SECURITY.md org policy the do-not-open-an-issue summary + 48h/7d expectations inline
CONTRIBUTING.md org process an index of all nine project documents
SUPPORT.md — where to ask what, plus the licensing note

Two deliberate deviations from a pure pointer

SECURITY.md sends reporters to the repo they found the bug in, rather than reproducing the org file's hardcoded link to the rossoctl/rossoctl advisory form. A vulnerability in moca should not be reported against a different repository.

SUPPORT.md states each repo carries its own LICENSE. A LICENSE here would not be inherited — verified: moca, cortex and examples each have their own real Apache-2.0 file. Adding one to this repo would imply an inheritance that does not exist.

Website impact: none

Root markdown is outside both the Docusaurus build (which sources docs/ and src/pages) and the link checker (which crawls the deployed site URL, not repo files). The existing scripts/sync-docs.sh behaviour is untouched.

Verification

  • Links checked with lychee 0.24.2: 23 OK, 0 errors. The single exclusion is the mailto: address.
  • Links deliberately re-verified after rossoctl/repo-template was made public — it had 404'd while private, which would otherwise have shipped a broken link in a public file.

Related

Pairs with rossoctl/repo-template, which ships the LICENSE and CODEOWNERS that GitHub cannot inherit.

@netlify

netlify Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for animated-crumble-fb8862 ready!

Name Link
🔨 Latest commit 7083e84
🔍 Latest deploy log https://app.netlify.com/projects/animated-crumble-fb8862/deploys/6ac9382842301d0008c2c6eb
😎 Deploy Preview https://deploy-preview-129--animated-crumble-fb8862.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

GitHub serves community-health files from a `.github` repository to every
repo in the org that does not define its own -- but only for a specific
set of filenames, and only from a repo literally named `.github`. This
repo had the issue templates and PR template but none of the four
documents, so nothing was being inherited: `community/profile` reported
`code_of_conduct: null` and `security: null` for rossoctl/moca.

Adds the four as pointers, not copies, so rossoctl/rossoctl stays the
single source of truth and these cannot drift from it:

  CODE_OF_CONDUCT.md  -> org policy + where conduct reports go
  SECURITY.md         -> org policy, plus the do-not-open-an-issue
                         summary and the 48h/7d expectations inline
  CONTRIBUTING.md     -> org process + an index of all nine project
                         documents
  SUPPORT.md          -> where to ask what, and the licensing note

Two deviations from a pure pointer, both deliberate:

SECURITY.md tells a reporter to file the advisory against the repository
where they found the issue, rather than reproducing the org file's link
to rossoctl/rossoctl's advisory form. A vulnerability in moca should not
be reported against a different repo.

SUPPORT.md states that each repo carries its own LICENSE and asks
readers to report any repo missing one. A LICENSE in this repo would
NOT be inherited -- verified: moca, cortex and examples each have their
own real Apache-2.0 file -- so adding one here would imply an
inheritance that does not exist.

Root markdown is outside both the Docusaurus build (which sources docs/
and src/pages) and the link checker (which crawls the deployed site), so
these files do not affect the website. Links verified with lychee: 23 OK,
0 errors.

Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com>
Signed-off-by: Mariusz Sabath <mrsabath@gmail.com>
@mrsabath
mrsabath force-pushed the docs/org-community-health-pointers branch from eccc3d5 to 7083e84 Compare October 9, 2026 18:53
@mrsabath
mrsabath merged commit 90309f1 into main Oct 9, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants