Update README instructions#18869
Merged
nataliasitko merged 7 commits intomainfrom Feb 24, 2026
Merged
Conversation
mmitoraj
reviewed
Feb 9, 2026
Co-authored-by: Małgorzata Świeca <malgorzata.swieca@sap.com>
a-thaler
reviewed
Feb 23, 2026
a-thaler
reviewed
Feb 23, 2026
| ``` | ||
| ```makefile | ||
| .PHONY: crd-docs-gen | ||
| crd-docs-gen: $(TABLE_GEN) manifests |
Contributor
There was a problem hiding this comment.
TABLE_GEN is an alias for the actual binary to call. That is specific to the makefile where you copied it from. If you are using make, you still need to build the binary somewhere and then call it here. Maybe put a sentence upfront that assumes that you builded the tool with a binary name "table-gen" and then use that name instead.
Also the "manifests" pre-condition you should remove as it is specific
a-thaler
reviewed
Feb 23, 2026
|
|
||
| ``` | ||
| <!-- TABLE-START --> | ||
| 2. Add a new target to your module's Makefile with the table generator commands: |
Contributor
There was a problem hiding this comment.
I prefer to switch the 2. with the 3. step, sounds more reasonable to me
a-thaler
reviewed
Feb 24, 2026
a-thaler
reviewed
Feb 24, 2026
a-thaler
reviewed
Feb 24, 2026
| - **--crd-filename**: Path to the CRD YAML file | ||
| - **--md-filename**: Path to the Markdown file where the table will be inserted | ||
|
|
||
| You can create different labels, group them under one, and add your target to the `generate` command. For a complete example, see the [Telemetry module's Makefile](https://github.com/kyma-project/telemetry-manager/blob/main/Makefile#L185). |
Contributor
There was a problem hiding this comment.
There is no "label" concept in makefiles and "grouping". Let's maybe drop this and just refer to the example for a complete example.
Co-authored-by: Andreas Thaler <andreas.thaler01@sap.com>
Removed redundant text about creating labels in the README.
a-thaler
approved these changes
Feb 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Changes proposed in this pull request:
Related issue(s)