Skip to content

Update docfx sanity check#2285

Merged
arminru merged 14 commits intoopen-telemetry:mainfrom
yufeih:docfx3
Mar 24, 2022
Merged

Update docfx sanity check#2285
arminru merged 14 commits intoopen-telemetry:mainfrom
yufeih:docfx3

Conversation

@yufeih
Copy link
Copy Markdown
Contributor

@yufeih yufeih commented Jan 22, 2022

Changes

Update docfx sanity check to use the latest version, which runs natively on linux and and is capable of more validations.

Fixes a broken anchor and a broken HTML tag problem detected by the new tool.

@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla Bot commented Jan 22, 2022 •
edited
Loading

CLA Signed

The committers are authorized under a signed CLA.

@yufeih
Copy link
Copy Markdown
Contributor Author

yufeih commented Jan 24, 2022

There is one error detected I'm not sure how to update. This file contains a link to README.md which isn't part of the website, I guess it is a trick to link to the parent directory, but there isn't any API specifications page. The API specifications link seems to point to the wrong location on this page

@yufeih yufeih marked this pull request as ready for review January 24, 2022 01:56
@yufeih yufeih requested review from a team January 24, 2022 01:56
@arminru arminru added the editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. label Jan 25, 2022
arminru
arminru reviewed Jan 25, 2022
View reviewed changes
Comment thread .github/workflows/checks.yaml Outdated
arminru
arminru reviewed Jan 26, 2022
View reviewed changes
Comment thread .github/workflows/checks.yaml Outdated
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 4, 2022

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions Bot added the Stale label Feb 4, 2022
@yufeih
Copy link
Copy Markdown
Contributor Author

yufeih commented Feb 7, 2022

I've updated the check and it should pass. The checks needs a maintainer approval.

@github-actions github-actions Bot removed the Stale label Feb 8, 2022
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 15, 2022

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions Bot added the Stale label Feb 15, 2022
@yufeih
Copy link
Copy Markdown
Contributor Author

yufeih commented Feb 15, 2022

The markdown-lint failure seems not related to this PR.

@github-actions github-actions Bot removed the Stale label Feb 16, 2022
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 23, 2022

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions Bot added the Stale label Feb 23, 2022
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 2, 2022

Closed as inactive. Feel free to reopen if this PR is still being worked on.

@github-actions github-actions Bot closed this Mar 2, 2022
@arminru
Copy link
Copy Markdown
Member

arminru commented Mar 2, 2022

Hi @yufeih! The markdownlint issue should have been resolved in the meantime, let's give it another try.

@arminru arminru reopened this Mar 2, 2022
arminru
arminru reviewed Mar 2, 2022
View reviewed changes
Comment thread .github/workflows/checks.yaml
@github-actions github-actions Bot removed the Stale label Mar 3, 2022
arminru
arminru approved these changes Mar 3, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@arminru arminru left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @yufeih!

Comment thread .github/workflows/checks.yaml
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 11, 2022

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions Bot added the Stale label Mar 11, 2022
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 18, 2022

Closed as inactive. Feel free to reopen if this PR is still being worked on.

@github-actions github-actions Bot closed this Mar 18, 2022
@arminru arminru reopened this Mar 22, 2022
@arminru arminru mentioned this pull request Mar 24, 2022
Open
@arminru arminru merged commit c36e8a0 into open-telemetry:main Mar 24, 2022
@lmolkova lmolkova mentioned this pull request May 6, 2024
Merged
2 tasks
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
@yufeih @arminru
Update docfx sanity check (open-telemetry#2285)
9a52636 
Co-authored-by: Armin Ruech <[email protected]>
schmikei pushed a commit to schmikei/opentelemetry-specification that referenced this pull request Apr 17, 2025
@yufeih @arminru
Update docfx sanity check (open-telemetry#2285)
29f3341 
Co-authored-by: Armin Ruech <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arminru arminru arminru approved these changes

@reyang reyang reyang approved these changes

Assignees

@tigrannajaryan tigrannajaryan

Labels

editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. Stale

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@yufeih @arminru @reyang @tigrannajaryan