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

Restructure concept pages for instrumentation #2763

Merged

Conversation

svrnm
Copy link
Member

@svrnm svrnm commented May 22, 2023

This PR aligns the structure of the concept pages for instrumentation with what we have for the language-specific pages (sub pages "manual", "automatic" and "libraries"), this hopefully also allows people to find those pages easier.


Preview: https://deploy-preview-2763--opentelemetry.netlify.app/docs/concepts/instrumentation/

Redirect tests:

@svrnm svrnm requested review from a team as code owners May 22, 2023 13:47
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

See inline for a few initial minor comments.

content/en/docs/concepts/instrumentation/automatic.md Outdated Show resolved Hide resolved
content/en/docs/concepts/instrumentation/_index.md Outdated Show resolved Hide resolved
content/en/docs/concepts/instrumentation/_index.md Outdated Show resolved Hide resolved
content/en/docs/concepts/instrumentation/_index.md Outdated Show resolved Hide resolved
content/en/docs/concepts/instrumentation/_index.md Outdated Show resolved Hide resolved
content/en/docs/concepts/instrumentation/libraries.md Outdated Show resolved Hide resolved
@svrnm
Copy link
Member Author

svrnm commented May 26, 2023

@chalin any idea why the html checker is failing?

========================================================================
docs/instrumentation/index.html
  target does not exist --- docs/instrumentation/index.html --> /docs/concepts/instrumenting/
========================================================================
✘✘✘ failed in 9.102509125s
1 errors in 393 documents

@chalin chalin force-pushed the restructure-concept-pages-for-instrumentation branch from b9005fd to 780f73e Compare May 26, 2023 11:53
@chalin
Copy link
Contributor

chalin commented May 26, 2023

@svrnm - because our current link checker doesn't understand redirects nor aliases. Therefore, you need to use the canonical path to a page. I just rebased and committed a fix for that path -- see 780f73e.

@svrnm
Copy link
Member Author

svrnm commented Jun 5, 2023

@svrnm - because our current link checker doesn't understand redirects nor aliases. Therefore, you need to use the canonical path to a page. I just rebased and committed a fix for that path -- see 780f73e.

Thank you @chalin!

@chalin @cartermp any more feedback or are we good to merge?

svrnm and others added 10 commits June 5, 2023 11:49
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
@chalin chalin force-pushed the restructure-concept-pages-for-instrumentation branch from 4d5a312 to 0fa3395 Compare June 5, 2023 15:49
@svrnm svrnm merged commit 249224e into open-telemetry:main Jun 6, 2023
8 checks passed
@svrnm svrnm deleted the restructure-concept-pages-for-instrumentation branch June 6, 2023 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants