Skip to content

Commit

Permalink
chore(component): fix contribution guidelines and make command (#691)
Browse files Browse the repository at this point in the history
Because

- The component definition in the guideline lacks a type, which makes it
not
  show up in the console.
- Make command referenced in guidelines is different than the one in
`Makefile`.

This commit

- Renames make command.
- Fixes definition in guidelines.
  • Loading branch information
jvallesm authored Oct 2, 2024
1 parent 7c94d45 commit bca3bed
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ gen-mock:
@go generate -run minimock ./...

.PHONY: gen-component-doc
gen-doc: ## Generate component docs
gen-component-doc: ## Generate component docs
@rm -f $$(find ./pkg/component -name README.mdx | paste -d ' ' -s -)
@cd ./pkg/component/tools/compogen && go install .
@go generate -run compogen ./pkg/component/...
Expand Down
1 change: 1 addition & 0 deletions pkg/component/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ component.
"id": "hello",
"uid": "e05d3d71-779c-45f8-904d-e90a050ca3b2",
"title": "Hello",
"type": "COMPONENT_TYPE_OPERATOR",
"description": "'Hello, world' operator used as a template for adding components",
"spec": {},
"availableTasks": [
Expand Down

0 comments on commit bca3bed

Please sign in to comment.