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.

Sign up for GitHub

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

Jump to bottom

ci(docs): change auto-generated docs path in kuma-website #8636

Merged
merged 2 commits into from
Dec 18, 2023
Merged

ci(docs): change auto-generated docs path in kuma-website #8636

merged 2 commits into from
Dec 18, 2023

Conversation

fabianrbz
Copy link
Contributor

@fabianrbz fabianrbz commented Dec 15, 2023 •
edited by lahabana
Loading

Related PR

Update github action to copy the auto-generated docs to app/assets/<versions>/raw/

These are static files and shoudn't be processed by Jekyll, moving them to app/assets prevents that from happening.

Checklist prior to review

  • Link to relevant issue as well as docs and UI issues --
  • This will not break child repos: it doesn't hardcode values (.e.g "kumahq" as a image registry) and it will work on Windows, system specific functions like syscall.Mkfifo have equivalent implementation on the other OS --
  • Tests (Unit test, E2E tests, manual test on universal and k8s) --
    • Don't forget ci/ labels to run additional/fewer tests
  • Do you need to update UPGRADE.md? --
  • Does it need to be backported according to the backporting policy? (this GH action will add "backport" label based on these file globs, if you want to prevent it from adding the "backport" label use no-backport-autolabel label) --

@fabianrbz
Update github action to copy the auto-generated docs to
ddc65f4 
`app/assets/<versions>/raw/`

These are static files and shoudn't be processed by Jekyll, moving them
to app/assets prevents that from happening.

Signed-off-by: Fabian Rodriguez <[email protected]>
@fabianrbz fabianrbz requested a review from a team as a code owner December 15, 2023 11:27
@fabianrbz fabianrbz requested review from jakubdyszkiewicz and Automaat and removed request for a team December 15, 2023 11:27
@lahabana lahabana changed the title Change auto-generated docs path in kuma-website ci(docs): change auto-generated docs path in kuma-website Dec 18, 2023
@lahabana lahabana added the ci/skip-test PR: Don't run unit and e2e tests (maybe this is just a doc change) label Dec 18, 2023
@fabianrbz @lahabana
Update .github/workflows/update-docs.yaml
0b0675f 
Co-authored-by: Charly Molter <[email protected]>
Signed-off-by: Fabian Rodriguez <[email protected]>
@lahabana lahabana enabled auto-merge (squash) December 18, 2023 15:00
@lahabana lahabana merged commit 6a2a9da into kumahq:master Dec 18, 2023
16 checks passed
@fabianrbz fabianrbz deleted the fix-raw-assets branch December 18, 2023 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lahabana lahabana lahabana approved these changes

@jakubdyszkiewicz jakubdyszkiewicz Awaiting requested review from jakubdyszkiewicz jakubdyszkiewicz is a code owner automatically assigned from kumahq/kuma-maintainers

@Automaat Automaat Awaiting requested review from Automaat Automaat is a code owner automatically assigned from kumahq/kuma-maintainers

Assignees
No one assigned
Labels
ci/skip-test PR: Don't run unit and e2e tests (maybe this is just a doc change)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@fabianrbz @lahabana