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

documentation: fix link to isInUseLocksError #7394

Merged
merged 2 commits into from
Nov 18, 2024

Conversation

ben-polinsky
Copy link
Contributor

@ben-polinsky ben-polinsky commented Nov 18, 2024

Links to namespace children must be prefaced by namespace name, even when inside of the namespace. Docs link validation failed to catch this error due an oversight in easing the upgrade to TypeScript 5.3/TypeDoc 0.24.x.

@ben-polinsky ben-polinsky requested review from a team as code owners November 18, 2024 19:24
@ben-polinsky ben-polinsky changed the title fix link to isInUseLocksError documentation: fix link to isInUseLocksError Nov 18, 2024
@pmconne
Copy link
Member

pmconne commented Nov 18, 2024

Docs link validation failed to catch this error due an oversight in easing the upgrade to TypeScript 5.3/TypeDoc 0.24.x.

Has the oversight been fixed? Are we confident no other instances of this same error exist elsewhere in the docs?

@ben-polinsky
Copy link
Contributor Author

ben-polinsky commented Nov 18, 2024

Has the oversight been fixed?

In progress. Link issues were still being logged, but builds would not fail because of them. I'll push a new version of bemetalsmith without this check.

Are we confident no other instances of this same error exist elsewhere in the docs?

Yes. The warnings would still be logged. Currently we have a couple changehistory warnings, but those are ok and expected if we remove an API. (They probably shouldn't be logged to avoid confusion.) Otherwise, there is one last warning which I am trying to track down Add remarks: target file bis/domains/SchemaA.ecschema.md could not be located.

@ben-polinsky ben-polinsky requested a review from a team as a code owner November 18, 2024 19:36
@ben-polinsky ben-polinsky merged commit 5e617a5 into master Nov 18, 2024
16 checks passed
@ben-polinsky ben-polinsky deleted the docs/isInUseLocksError-link-fix branch November 18, 2024 20:13
@ben-polinsky
Copy link
Contributor Author

@Mergifyio backport release/4.11.x release/4.10.x

Copy link
Contributor

mergify bot commented Nov 18, 2024

backport release/4.11.x release/4.10.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Nov 18, 2024
Co-authored-by: Ben Polinsky <ben-polinsky@users.noreply.github.com>
(cherry picked from commit 5e617a5)
mergify bot pushed a commit that referenced this pull request Nov 18, 2024
Co-authored-by: Ben Polinsky <ben-polinsky@users.noreply.github.com>
(cherry picked from commit 5e617a5)
ben-polinsky added a commit that referenced this pull request Nov 18, 2024
…e/4.10.x] (#7396)

Co-authored-by: Ben Polinsky <78756012+ben-polinsky@users.noreply.github.com>
ben-polinsky added a commit that referenced this pull request Nov 18, 2024
…e/4.11.x] (#7395)

Co-authored-by: Ben Polinsky <78756012+ben-polinsky@users.noreply.github.com>
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.

2 participants