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

Substitution key hint shows even when a sub is used #779

Closed
1 of 3 tasks
colleenmcginnis opened this issue Mar 19, 2025 · 4 comments · Fixed by #809
Closed
1 of 3 tasks

Substitution key hint shows even when a sub is used #779

colleenmcginnis opened this issue Mar 19, 2025 · 4 comments · Fixed by #809
Labels

Comments

@colleenmcginnis
Copy link
Contributor

Describe the bug

I'm seeing hints suggesting that a substitution key is not used when it is used in one or more Markdown files.

Note: In the example I provided below, the Markdown file where the variables are used also use page-level subs in the frontmatter. I'm not sure if that could be the cause.

Expected behavior

I should only get hints when a substitution key is actually not used.

Steps to reproduce

Here's an example:

  1. The build for apm-agent-nodejs shows two hints:
    Hint: Substitution key 'ecloud' is not used in any file
    NOTE: /github/workspace/docs/docset.yml
     
    Hint: Substitution key 'apm-lambda-ext' is not used in any file
    NOTE: /github/workspace/docs/docset.yml
    
  2. But when I check for usage of those subs, I find uses:

Tooling

  • docs-builder
  • migration tooling
  • I'm not sure
@colleenmcginnis
Copy link
Contributor Author

This seems to be pretty widespread in recent PRs.

@shainaraskas
Copy link
Contributor

Note: In the example I provided below, the Markdown file where the variables are used also use page-level subs in the frontmatter. I'm not sure if that could be the cause.

I'm seeing this in pages where there are no front matter keys set

@Mpdreamz
Copy link
Member

Forgot one line in the one place we parse variables 😸

#809 should fix this.

@colleenmcginnis
Copy link
Contributor Author

Thank you! I'm still seeing a few problems 😬 #814.

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

Successfully merging a pull request may close this issue.

3 participants