feat: add api docs #13
Conversation
daviderli614
force-pushed
the
feat/api-docs
branch
from
93d6c94 to
bd262ed
Compare
|
|
||
| ## Tool Versions | ||
| KUSTOMIZE_VERSION ?= v5.5.0 | ||
| CONTROLLER_TOOLS_VERSION ?= v0.16.4 | ||
| ENVTEST_VERSION ?= release-0.19 | ||
| GOLANGCI_LINT_VERSION ?= v1.61.0 | ||
| CRD_REF_DOCS_VERSION ?= v0.1.0 |
There was a problem hiding this comment.
It means that we need to manually maintain the tool's version. A better way is to leverage dependabot to automatically bump it. Refer to https://github.com/etcd-io/etcd/tree/main/tools/mod
But it's good enough in the very first step. We can continue to enhance it in next step.
There was a problem hiding this comment.
Now need to set the tool version manually, can use dependabot to automatically bump it later.
|
Thanks @daviderli614 for the contribution. The generated docs looks great. |
daviderli614
force-pushed
the
feat/api-docs
branch
from
1ea6e71 to
13ce751
Compare
Makefile
Outdated
| @@ -190,6 +203,10 @@ envtest: $(ENVTEST) ## Download setup-envtest locally if necessary. | |||
| $(ENVTEST): $(LOCALBIN) | |||
| $(call go-install-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest,$(ENVTEST_VERSION)) | |||
|
|
|||
| .PHONY: crd-ref-docs | |||
| crd-ref-docs: ## Install crd-ref-docs. | |||
| GOBIN=$(LOCALBIN) GO111MODULE=on go install github.com/elastic/crd-ref-docs@$(CRD_REF_DOCS_VERSION) | |||
There was a problem hiding this comment.
I see that there is already a go-install-tool defined in the Makefile. We need to have a consistent way to manage all the tools per https://github.com/etcd-io/etcd-operator/pull/13/files#r1898432778. This can be enhanced in followup PRs.
There was a problem hiding this comment.
Hi, I changed the command to the following:
.PHONY: crd-ref-docs
crd-ref-docs: $(CRD_REF_DOCS) ## Install crd-ref-docs tool, ref: https://github.com/elastic/crd-ref-docs.
$(CRD_REF_DOCS): $(LOCALBIN)
$(call go-install-tool,$(CRD_REF_DOCS),github.com/elastic/crd-ref-docs@$(CRD_REF_DOCS_VERSION))
|
@daviderli614 please rebase this PR instead of merging the changes from main. |
daviderli614
force-pushed
the
feat/api-docs
branch
from
5df6975 to
86e013f
Compare
daviderli614
force-pushed
the
feat/api-docs
branch
2 times, most recently
from
b726065 to
a411c37
Compare
Please rebase and squash the commits. Search " |
I know, give me some time. |
daviderli614
force-pushed
the
feat/api-docs
branch
from
7f33e6a to
80c1c9e
Compare
daviderli614
force-pushed
the
feat/api-docs
branch
from
3f02c91 to
90a8c3e
Compare
daviderli614
force-pushed
the
feat/api-docs
branch
from
09594d3 to
0426948
Compare
daviderli614
force-pushed
the
feat/api-docs
branch
2 times, most recently
from
4785f66 to
2d5ec62
Compare
Signed-off-by: liyang <[email protected]> Update Makefile Co-authored-by: Benjamin Wang <[email protected]> Signed-off-by: liyang <[email protected]>
Signed-off-by: liyang <[email protected]>
daviderli614
force-pushed
the
feat/api-docs
branch
from
46092e0 to
fef3297
Compare
|
Hi @ahrtr |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ahrtr, daviderli614 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Add etcd-operator api documentation, reference tool: https://github.com/elastic/crd-ref-docs
We can
make api-docsto generate the latest api documentation.Preview: docs.md