[guide] CONTRIBUTING data model table omits members, community-roster, and projects-born data sources

Open Beginner friendly
#172 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript
Domain
documentation

Research direction

Start in CONTRIBUTING.md at the “Data contribution model” table around lines 33–37, then review the named data files, package.json scripts, and referenced components. Document the /members, community people, and ProjectsBorn data sources with their update or generation commands, and state that award changes require npm run generate:members. Done means contributors can identify the correct file and refresh step for each surface.

Written by the indexing model from the issue text.

Description

agent/guide documentation hive/hosted-available-lke648397-260827-5n31

Documentation Gap

The "Data contribution model" table in CONTRIBUTING.md (main@b0c978a, lines 33-37) lists only /awards, /metrics, and /architectures. Three other data-driven surfaces have zero contributor-facing documentation (verified: members.json, community-roster.json, projects-born.json, generate:members, fetch:community-people have no mention in README/CONTRIBUTING/AGENTS/docs):

  1. /members page ← data/members.json, generated by npm run generate:members from data/awards.json + data/architectures/catalog.json (scripts/generate-members.mjs). A contributor adding an award winner gets no instruction to regenerate, so /members silently goes stale — import:architectures chains generate:members but award edits do not, and there is no CI freshness check.
  2. Community people lightboxes ← curated data/community-roster.json, refreshed into data/community-people.json by npm run fetch:community-people (weekly .github/workflows/refresh-community-people.yml). No doc says which file to edit to add/fix a person.
  3. data/projects-born.json powers the ProjectsBorn component on /practitioners (src/components/ProjectsBorn/index.js:2) with no documented provenance or update process.

Consumers verified at src/components/MemberDirectory/index.js:4 and src/components/CommunityPeople/index.js:2; scripts exist in package.json.

Impact

Contributors editing awards or community data produce silently stale pages; nobody can discover the correct edit-and-regenerate workflow from the docs.

Recommendation

Extend the table with the three rows (page, data source, generation/validation command) and add a rule that award changes require re-running npm run generate:members.

Filed by guide agent (ACMM L4 — issues-only mode)

🐝 Hive Agent: guide | Instance: hosted-available-lke648397-260827-5n31 | SHA: unknown

— hive: agent=guide backend=copilot model=kimi-k3

Dominant language
JavaScript
Stars
0
Forks
2
Avg merge
2d 22h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

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 cncf/endusers

All issues in cncf/endusers

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.