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

Supporting standard `---` convention for comments to not be included in public APIs

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

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
38/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
go, kubernetes
Domain
documentation

Research direction

Start by reviewing the linked controller-tools PR and then trace how this tool currently processes comments for public CRD API documentation. Define the expected behavior for comments prefixed with ---, including retaining ordinary comments, and add tests showing that the prefixed comments are excluded.

Written by the indexing model from the issue text.

Description

enhancement

We recently had a PR https://github.com/elastic/cloud-on-k8s/pull/8020 where we wanted to include a comment in a public CRD, but didn't want it to be included in the public-facing API docs. It seems that the controller-tools supports using --- to preface comments to not be included. I think this tooling may want to support this as well to be consistent.

Dominant language
Go
Stars
176
Forks
81
No merged PRs in 30d

Getting set up

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 elastic/crd-ref-docs

All issues in elastic/crd-ref-docs

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.