Delete internal API docs after generation #10065
Conversation
|
Issues linked to changelog: |
nfuden
changed the title
sheidkamp
changed the title
There was a problem hiding this comment.
Reposting from Slack for visibility -
In several of our gloo api docs we link to a bunch of these pages, so many links will be broken if we delete these.
I had a hunch that we autogenerate some of these links. for example, in the settings.proto reference docs, we link to the consul query_options proto (which is one of the files being deleted). but in the actual settings proto we don’t hardcode a link.
in solo-kit it looks like the API ref doc template uses a linkForField function. the code for that function is here.
long story short - i think we would need to change that linkForField function in solo-kit to somehow recognize when the field is one of these external protos that we will no longer be creating docs for, and either simply do not create a link for it, or hard-code a link to the appropriate external doc (like a link to envoy api docs etc)
sheidkamp
changed the title
…docs Delete internal API docs after generation
…docs Delete internal API docs after generation
…docs Delete internal API docs after generation
Description
Delete external API docs after generation
Docs changes
Delete the generated internal API docs after generation
May require a manual update of existing files in firebaseConfirmed with docs that it does not.Testing steps
Run
make go-generate-apis fmtvalidate that the removed files are no longer present on the file-system:
Notes for reviewers
There isn't a good way to validate this e2e/in CI without running against production, so we will need to run this through ci after review merge, ideally with k8sgateway#10334 which needs the same validation.
Checklist:
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works