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

[editorial] Drop path_base_for_github_subdir from front matter #1846

Merged

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Jan 28, 2025

  • Contributes to [editorial] Inline Hugo front matter #1821
  • Drops path_base_for_github_subdir from the Hugo front matter for all docs/**/README.md files. Note that we keep the cascaded value in the docs root readme.

@chalin chalin requested review from a team as code owners January 28, 2025 23:57
@trask trask added the Skip Changelog Label to skip the changelog check label Jan 29, 2025
Copy link
Contributor

@lmolkova lmolkova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no idea what path_base_for_github_subdir does, but I trust you @chalin :)

@lmolkova lmolkova merged commit 7639732 into open-telemetry:main Jan 29, 2025
14 checks passed
@chalin chalin deleted the chalin-im-drop-path-base-2025-01-28 branch January 29, 2025 05:13
@chalin
Copy link
Contributor Author

chalin commented Jan 29, 2025

I have no idea what path_base_for_github_subdir does, but I trust you @chalin :)

@lmolkova - every doc page on OTel.io has a "View source" link. path_base_for_github_subdir is used to compute the value of the "View source" URL for pages whose source isn't the OTel.io repo itself. README.md files were special in that they needed to be renamed, and so each such file required its own path_base config. We won't need that any more (to know why, see open-telemetry/opentelemetry.io#6103). I hope that helps a bit to understand the purpose of that field. :)

(Btw, the "View source" is temporarily broken. A fix should land soon: open-telemetry/opentelemetry.io#6107.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog Label to skip the changelog check
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants