Trust manager API doc generation #1170
Conversation
jetstack-bot
added
dco-signoff: yes
✅ Deploy Preview for cert-manager-website ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
SgtCoDFish
force-pushed
the
trust-manager-api-docs
branch
2 times, most recently
from
ad81f28
to
0a40d22
Compare
content/docs/manifest.json
Outdated
| }, | ||
| { | ||
| "title": "trust-manager API Docs", | ||
| "path": "/docs/projects/trust-manager-api-ref.md" |
There was a problem hiding this comment.
note: I couldn't decide between /projects and /reference
There was a problem hiding this comment.
we might need a API ref page for approval-policy too
There was a problem hiding this comment.
I would like to have it all in a separate subsection (eg /docs/projects/reference or /docs/reference/projects)
There was a problem hiding this comment.
I suppose it depends whether we are trying to make all these projects appear as an integrated suite of software or whether we'd rather keep each project more self container.
I think for now, I'd prefer it in /docs/projects/trust-manager/api-reference.md. My 2c
There was a problem hiding this comment.
I think for now, I'd prefer it in /docs/projects/trust-manager/api-reference.md. My 2c
Totally reasonable, yeah. I'll go for making trust-manager its own section, then, as in:
Projects
-> approver-policy
-> ...
-> trust-manager
---> Introduction
---> API Reference Docs
(I think it's a valuable long-term goal for trust-manager to be able to run entirely independently of cert-manager, to the point where it could live in its own independent docs site like https://trust-manager.cert-manager.io. I think a lot of the other subprojects won't reasonably exist independently of cert-manager, but trust-manager is useful even if you never install cert-manager)
| set -o nounset | ||
| set -o pipefail | ||
|
|
||
| # This script downloads a crdoc binary for local use if such a binary doesn't already exist. |
There was a problem hiding this comment.
note: this is copied from the htmltest script in the same directory. It could obviously be improved (multi arch support, etc) but this works well.
SgtCoDFish
force-pushed
the
trust-manager-api-docs
branch
2 times, most recently
from
9f2a4eb
to
7552def
Compare
Uses trust-manager 0.3.0 for generation. Also adds custom template for trust-manager, which might be applicable to cert-manager in the future. Signed-off-by: Ashley Davis <ashley.davis@jetstack.io>
SgtCoDFish
force-pushed
the
trust-manager-api-docs
branch
from
7552def
to
efefbf7
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: inteon, SgtCoDFish 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 |
|
Thanks both for the reviews / comments! |
This uses crdoc instead of the tool we use for cert-manager. crdoc might be a candidate for use instead of our current tool (at least in part due to issues with #1168)
This is a prerequisite for #1160 , which will be updated to include docs generated from trust-manager 0.4.0 (when it's tagged)
Preview: https://deploy-preview-1170--cert-manager-website.netlify.app/docs/projects/trust-manager-api-ref/