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

Simplify doc content reviewer life: warn about aliases when pages have changed #463

Closed
tbouffard opened this issue Nov 6, 2022 · 0 comments · Fixed by #483
Closed

Simplify doc content reviewer life: warn about aliases when pages have changed #463

tbouffard opened this issue Nov 6, 2022 · 0 comments · Fixed by #483

Comments

@tbouffard
Copy link
Member

tbouffard commented Nov 6, 2022

In the past, we saw that aliases are often missing. People are not aware that they must configure redirects for moved or deleted pages.
As we did with #373, we should remind/warn contributors when aliases are required.

In the same PR comment we created with #373, we could include a dedicated paragraph about the pages that need an alias.
My proposal is to list the url of former pages, the reviewer then click on the link to check that the redirect is setup (remember that Antora generates redirects that also work in the Surge preview) and goes to the right destination page.

In the future, we could automate that the redirect is correctly setup by running http get commands to at least detect missing alias. But reviewers will always as to check the destination because we cannot automate the check (always specific to the use case)

@tbouffard tbouffard changed the title Simplify doc content reviewer life: warn about alias when pages have changed Simplify doc content reviewer life: warn about aliases when pages have changed Nov 6, 2022
benjaminParisel added a commit that referenced this issue Nov 10, 2022
Create a composite GitHub action
Adding links for created/updated files
Adding a warning if some file is deleted or renamed on a PR

Covers #373
Covers #463
@benjaminParisel benjaminParisel self-assigned this Nov 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

2 participants