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

Fix Providers doc refer to non-existent 'events.md' #602

Closed
wants to merge 1 commit into from

Conversation

kingdonb
Copy link
Member

Another commit to go with:
* fluxcd/source-controller#1200

Signed-off-by: Kingdon Barrett <kingdon@weave.works>
@kingdonb
Copy link
Member Author

There is no events.md - this is the result of anchor/404 testing being done on fluxcd/website#1573 and associated PRs

Please review and merge at will

@somtochiama
Copy link
Member

@kingdonb Taking a closer look at this,
There is an events.md. The changes in this pull request result in a 404 when someone is navigating the spec docs readme from the GitHub UI.

The problem stems from the script in fluxcd/website importing events.md as event.md so it should be fixed there.
https://github.com/fluxcd/website/blob/1c2fa808008cd7ee0d0adfe9d2483d7db5320293/hack/import-flux2-assets.sh#L155

@stefanprodan
Copy link
Member

Pinging @makkes

@stefanprodan stefanprodan added the hold Issues and pull requests put on hold label Aug 16, 2023
@makkes
Copy link
Member

makkes commented Aug 16, 2023

Sorry for the confusion. We had to change the docs structure in #582 so that all API type pages are pluralized. The import-flux2-assets.sh script in the main branch of the website repo will fail with the new structure until fluxcd/website#1577 is merged from which point it will pass again. Since we're not building the docs from the n-c main branch but only from a released version the docs structure change onf #582 has no impact on the current docs site.

I think we can close this PR and wait until fluxcd/website#1577 has been merged. Then, the anchor check should not fail, anymore.

@kingdonb
Copy link
Member Author

OK, 👍 closing

@kingdonb kingdonb closed this Aug 16, 2023
@kingdonb kingdonb deleted the fix-bad-links branch August 16, 2023 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hold Issues and pull requests put on hold
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants