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

Fix broken RST docs #3062

Merged
merged 3 commits into from
Dec 5, 2024
Merged

Fix broken RST docs #3062

merged 3 commits into from
Dec 5, 2024
+7 −7

Conversation

buger
Copy link
Contributor

@buger buger commented Dec 3, 2024 •
edited by emdneto
Loading

Description

Fix broken RST docs, and improve the examples

Address part of #3061

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Build docs locally and validated rendering

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@buger buger requested a review from a team as a code owner December 3, 2024 07:44
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Dec 3, 2024 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: emdneto / name: Emídio Neto (f4538f7, 035930f)
  • ✅ login: buger / name: Leonid Bugaev (7536c02)

@github-actions github-actions bot requested a review from nemoshlag December 3, 2024 07:45
@xrmx xrmx added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Dec 3, 2024
emdneto
emdneto requested changes Dec 3, 2024
View reviewed changes
Copy link
Member

@emdneto emdneto left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the PR. I think even with that fix, we'll still face broken RSTs because the actual docs come from here for example. So, the correct fix should be in the respective doc at __init__.py of each package.

@buger
Copy link
Contributor Author

buger commented Dec 3, 2024

Oh, I get it now 🤔
Did not realised the full flow. Will give a one more go.

@buger
Copy link
Contributor Author

buger commented Dec 3, 2024

@emdneto done!

@xrmx xrmx self-requested a review December 4, 2024 08:59
xrmx
xrmx approved these changes Dec 5, 2024
View reviewed changes
Copy link
Contributor

@xrmx xrmx left a comment

Choose a reason for hiding this comment

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

I think we can get the syntax fixes now and revise the content later

@xrmx xrmx merged commit 6c92f38 into open-telemetry:main Dec 5, 2024
573 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emdneto emdneto emdneto approved these changes

@xrmx xrmx xrmx approved these changes

@nemoshlag nemoshlag Awaiting requested review from nemoshlag

Assignees

@nemoshlag nemoshlag

Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@buger @xrmx @emdneto @nemoshlag