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

Ignore a type but still document its fields when embedded

Open
  • Is something wrong?
#75 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
go
Domain
documentation

Research direction

Start by tracing the ignoreTypes behavior changed in #73 and the handling of embedded structs marked json:",inline". Confirm how ignored types are excluded while their embedded fields remain in generated documentation, then add coverage for this case and verify the generated output.

Written by the indexing model from the issue text.

Description

enhancement

#73 changed (fixed) the behavior of ignoreTypes so that they are actually excluded from the output. I was previously using the ignoreTypes list to ignore types that are only embedded in other structs. The types would not receive their own section/table in the resulting docs, but their fields would still be documented when they were embedded in other structs (with json:",inline"). It would be nice if this use case could be supported in the tool.

Dominant language
Go
Stars
174
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.