Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Push generated command line docs periodically to the docs website #6870

Open
2 of 4 tasks
lahabana opened this issue Dec 18, 2024 · 0 comments
Open
2 of 4 tasks

Push generated command line docs periodically to the docs website #6870

lahabana opened this issue Dec 18, 2024 · 0 comments
Labels

Comments

@lahabana
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Does this enhancement require public documentation?

  • I have added an Acceptance Criteria item for adding and/or adjusting public documentation (if applicable)

Problem Statement

We have docs for the next version of KIC online.
Unfortunately we only update our generated docs as part of the release process with: https://github.com/Kong/kubernetes-ingress-controller/blob/main/.github/workflows/release_docs.yaml

This is a little annoying as when we're preparing the release blogpost for example we can't get links with the newer flags.

Proposed Solution

Push daily the generated docs in a PR for the main branch.

Additional information

@czeslavo pointed out: we'd only have to keep track of the "unreleased" version on the KIC side or deduct it from the kong.yaml in docs repo when pushing from the workflow.

Acceptance Criteria

  • command line flags are updated once a day for main branch
  • release checklist is updated to remove this step as it's done incrementally
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant