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

[Feature Request]: Add error-checking for removal of files/URLs used by product #736

Open
2 tasks done
lcawl opened this issue Mar 13, 2025 · 0 comments
Open
2 tasks done

Comments

@lcawl
Copy link
Contributor

lcawl commented Mar 13, 2025

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

With the changes to the way we're handling versioning in the Docs V3, we'll have scenarios where URLs that are used in the product (for example, in error messages or logs or UIs) need to continue to exist (or have appropriate redirects) for as long as that product version is supported.

In the old documentation system, as long as the old product version was pointing to an old docs version, it didn't matter if we removed a page from the latest docs versions. That will no longer be true. We'll need to ensure that either the page persists (with version appropriate trail markers if the content moves or changes radically) or that appropriate redirects are created.

Proposed Solution

@Mpdreamz suggested that we could add something like this:

locked:
  - path/to/yaml

... And start erroring if that page is no longer available or does not redirect. That way we can ensure certain pages always resolve.

Examples and Research

This issue arose as part of the discussion about how to handle pages that are linked from the Elasticsearch logs and error messages (https://github.com/elastic/elasticsearch/blob/main/server/src/main/resources/org/elasticsearch/common/reference-docs-links.txt) and how to ensure that the URLs used in V9.0.0, for example, continue to exist. And in the case of version-specific troubleshooting content or performance tuning content that is likely to change over time--how to ensure that when/if version-specific page variations arise that the URLs that existed in the early releases still resolve to something appropriate.

Alternative Solutions

Alternatively, we could add rely on (at a minimum) link checking all the link services that are used across our various product repos. The link checking would still need to run against all in-support branches of those link services.

Relates to #123

Additional Context

No response

How important is this feature to you?

Important

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant