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

Docs build passes despite internal links in migration guide #79486

Closed
DaveCTurner opened this issue Oct 19, 2021 · 3 comments
Closed

Docs build passes despite internal links in migration guide #79486

DaveCTurner opened this issue Oct 19, 2021 · 3 comments
Labels
>bug Team:Docs Meta label for docs team

Comments

@DaveCTurner
Copy link
Contributor

The migration guide docs are re-used in the stack-wide Install and Upgrade Guide which means we cannot use internal links there. I've fallen foul of this rule multiple times, most recently here. Could we fail the PR build on this misuse rather than relying on an eagle-eyed reviewer spotting the problem?

@DaveCTurner DaveCTurner added >bug Team:Docs Meta label for docs team needs:triage Requires assignment of a team area label labels Oct 19, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@lcawl
Copy link
Contributor

lcawl commented Oct 20, 2021

As soon as the appropriate files exist in the various repos, there's no reason we can't add those references in the Installation and Upgrade Guide. The docs build checks in individual PRs will then fail when inappropriate links are added. I've created elastic/stack-docs#1852 to update the files pulled in for 7.x branches. This is usually something we check as part of our docs release process, however, so we typically don't catch these too far in advance.

My hope is that the need for this repeated content will go away as we reorganize our content in the new documentation system.

@romseygeek romseygeek removed the needs:triage Requires assignment of a team area label label Nov 11, 2021
@lockewritesdocs
Copy link
Contributor

While valid, we're moving towards a new doc system, and will be investing less time and resources in patching the old one. I'll mark this issue as closed unless someone has the bandwidth to carry it forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>bug Team:Docs Meta label for docs team
Projects
None yet
Development

No branches or pull requests

5 participants