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

Clean up broken links and unused variables in docset.yml files #811

Open
41 of 48 tasks
lcawl opened this issue Mar 17, 2025 · 0 comments
Open
41 of 48 tasks

Clean up broken links and unused variables in docset.yml files #811

lcawl opened this issue Mar 17, 2025 · 0 comments
Labels
bug Something isn't working

Comments

@lcawl
Copy link
Contributor

lcawl commented Mar 17, 2025

Description

This issue kind of deals with three different problems, but if we're going to have to touch every repo that contains MD files again, it makes sense to deal with all three at once:

  1. There are some asciidoc-style links that were not converted to V3-style links. For example: https://www.elastic.co/guide/en/cloud/current/ec-add-user-settings.html[user setting] They seem to often be surrounded by parentheses, but can likely be found mostly easily by searching for ".html[" in *.md files. They should instead be updated to use the following format:
    https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/syntax/links.
  2. Some of these broken links exist in the substitutions defined in the docset.yml files. Since all of our docset.yml files currently have the same list of substitutions, I think it means every repo that we've migrated docs into will be affected.
  3. Per chat with @colleenmcginnis and @Mpdreamz if we're touching all those files anyway, it's a good time to remove all the variables that are unused in each repo. That way we don't have to unnecessarily update multiple docset.yml files in the future for substitutions that aren't even used there.

Resources

Please check off the repo in this list if you've confirmed that either the problems don't exist in that repo or that they're fixed (e.g. by adding commits to existing PRs in some cases)

NOTE: Warnings about unused substitutions were added per elastic/docs-builder#762 but there might be a bug in that per elastic/docs-builder#779

Which documentation set does this change impact?

Elastic On-Prem and Cloud (all)

Feature differences

N/A

What release is this request related to?

9.0

Collaboration model

The documentation team

Point of contact.

N/A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant