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.

Sign up for GitHub

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

Jump to bottom

[fr] Move new observability primer page #5927

Merged
merged 22 commits into from
Jan 20, 2025
Merged

[fr] Move new observability primer page #5927

merged 22 commits into from
Jan 20, 2025

Conversation

iguitton
Copy link
Contributor

@iguitton iguitton commented Jan 14, 2025 •
edited by chalin
Loading

@iguitton
Issue open-telemetry#5913 Move new observability primer page
32e5fea 
* moved observability-primer.md under fr/docs/concepts
@iguitton iguitton requested a review from a team as a code owner January 14, 2025 09:30
@opentelemetrybot opentelemetrybot requested review from a team January 14, 2025 09:30
@dmathieu
Copy link
Member

It looks like there are now hash issues in links (see the failing GH Action).

@iguitton
Issue open-telemetry#5913: Move new observability primer page
2c92ec7 
* Updated hastag in what-is-opentelemetry.md
@iguitton
Issue open-telemetry#5913 Move new observability primer page
dda9adc 
New attempt to fix the link issue
@iguitton
Copy link
Contributor Author

/fix:format

@opentelemetrybot
Copy link
Collaborator

You triggered fix:format action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/12766122241

@opentelemetrybot
Copy link
Collaborator

fix:format was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

chalin
chalin requested changes Jan 14, 2025
View reviewed changes
content/fr/_index.md Outdated Show resolved Hide resolved
@chalin chalin changed the title Issue #5913 Move new observability primer page [fr] Move new observability primer page Jan 14, 2025
@chalin
Copy link
Contributor

chalin commented Jan 14, 2025

The "hash does not exist" link-check failures of this PR are because content/fr/docs/what-is-opentelemetry.md doesn't have heading IDs, as recommended in Localization > Heading anchors. The proper fix is here is to add the heading IDs in content/fr/docs/what-is-opentelemetry.md.

@chalin
Copy link
Contributor

chalin commented Jan 14, 2025 •
edited
Loading

In passing, I'd like to suggest that you add "Fixes #XXXX" to the opening comment of a PR rather than the title. By doing so you allow GitHub to automatically link the PR to the issue. This make is easier for all to navigate to the issue, and allows GitHub to know that the issue can be closed when the PR is merged. (I've edited the comment to this effect, hopefully, that's ok with you.)

@opentelemetrybot opentelemetrybot requested review from a team January 15, 2025 09:23
@iguitton
* Fixes [fr] Move new observability-primer page under docs open-telem…
4c74763 
…etry#5913

* Added all required heading IDs in what-is-opentelemetry.md
@iguitton
Copy link
Contributor Author

@chalin, I’ve reverted the changes and added heading IDs to what-is-opentelemetry.md, but the issue persists. Could you advise on the next steps? I’m unsure why this is still failing and would appreciate your guidance.

@chalin
Copy link
Contributor

chalin commented Jan 17, 2025

@chalin, I’ve reverted the changes and added heading IDs to what-is-opentelemetry.md, but the issue persists. Could you advise on the next steps? I’m unsure why this is still failing and would appreciate your guidance.

Hi @iguitton. There are two issues:

(1) As mentioned in #5913, you need to move the new observability-primer page under docs. This PR just creates a new file under docs, but the old one is still there.

(2) As reported in https://github.com/open-telemetry/opentelemetry.io/actions/runs/12825801302/job/35764655095?pr=5927:

fr/docs/index.html
  hash does not exist --- fr/docs/index.html --> concepts/observability-primer/#what-is-observability

Your new page fr/docs/concepts/observability-primer still doesn't have the heading ID what-is-observability, as you can see here:

image

You did add the heading ID to content/fr/docs/what-is-opentelemetry.md, but it is missing from observability-primer.md.

My suggestion, to avoid such issues in the future, is to add heading IDs for all headings as you translate new pages, rather than wait later for the link checker to report errors.

@iguitton
* Fixes [fr] Move new observability-primer page under docs open-telem…
8a423e6 
…etry#5913

* Deletes observability-primer.md under fr/concepts
* Adds heading IDs to content/fr/docs/concepts/observability-primer.md
* Adds #what-is-opentelemetry whenever required in what-is-opentelemetry.md
@opentelemetrybot opentelemetrybot requested review from a team January 20, 2025 09:12
@iguitton
Copy link
Contributor Author

/fix:format

@opentelemetrybot
Copy link
Collaborator

You triggered fix:format action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/12864800535

@opentelemetrybot
Copy link
Collaborator

fix:format was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

@iguitton
* Fixes [fr] Move new observability-primer page under docs
67b413b 
* updated #les-traces-distribuées to #distributed-traces
@iguitton
Copy link
Contributor Author

/fix:format

@opentelemetrybot
Copy link
Collaborator

You triggered fix:format action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/12865077832

@opentelemetrybot
Copy link
Collaborator

fix:format was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

@iguitton
Copy link
Contributor Author

/fix:all

@opentelemetrybot
Copy link
Collaborator

You triggered fix:all action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/12865479859

@opentelemetrybot
Copy link
Collaborator

fix:all was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

chalin
chalin approved these changes Jan 20, 2025
View reviewed changes
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.

LGTM 🎉

@iguitton
Copy link
Contributor Author

LGTM 🎉

Thanks for your patience and help, @chalin—it is much appreciated! 😊

@chalin chalin requested a review from a team January 20, 2025 16:47
@chalin
Copy link
Contributor

chalin commented Jan 20, 2025

Waiting on an approval from @open-telemetry/docs-fr-approvers

@chalin chalin merged commit fed30fe into open-telemetry:main Jan 20, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chalin chalin chalin approved these changes

@dmathieu dmathieu dmathieu approved these changes

Assignees
No one assigned
Labels
lang:fr
Projects
SIG Comms: PRs & Issues
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[fr] Move new observability-primer page under docs
4 participants
@iguitton @dmathieu @opentelemetrybot @chalin