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

[eslint-plugin-sdk] Broken links on readme and other places related to doc rules #9698

Closed
KarishmaGhiya opened this issue Jun 24, 2020 · 3 comments · Fixed by #9705
Closed

[eslint-plugin-sdk] Broken links on readme and other places related to doc rules #9698

KarishmaGhiya opened this issue Jun 24, 2020 · 3 comments · Fixed by #9705
Assignees
@willmtemple @KarishmaGhiya
Labels
Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system.

Comments

@KarishmaGhiya
Copy link
Member

KarishmaGhiya commented Jun 24, 2020 •
edited
Loading

We are running link verification on the repo and noticed broken links on the eslint sdk .md files. The doc/rules folder seems to be missing. Also while fixing the links it will be great to have full links to master instead of relative links - in accordance with the latest doc guidenlines.
Here are the broken links -
Found 28 broken links on page file:///D:/a/1/s/common/tools/eslint-plugin-azure-sdk/README.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-config-sourcemap.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-config-strict.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-config-target.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-doc-internal.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-error-handling.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-modules-only-named.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-naming-drop-noun.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-naming-options.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-naming-subclients.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-no-const-enums.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-no-namespaces.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-author.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-bugs.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-engine-is-present.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-files-required.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-homepage.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-keywords.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-license.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-main-is-cjs.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-module.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-name.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-repo.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-required-scripts.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-sideeffects.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-package-json-types.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-pagination-list.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-use-interface-parameters.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-use-promises.md
WARNING: Link to file does not exist D:\a\1\s\tools\eslint-plugin-azure-sdk\docs\rules\ts-versioning-semver.md
@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Jun 24, 2020
@KarishmaGhiya KarishmaGhiya added the Client This issue points to a problem in the data-plane of the library. label Jun 24, 2020
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Jun 24, 2020
@KarishmaGhiya KarishmaGhiya added EngSys This issue is impacting the engineering system. needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Jun 24, 2020
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Jun 24, 2020
@willmtemple
Copy link
Contributor

The docs folder didn't make it over when I added this to the repo. Not sure why. We could revive it from the history of https://github.com/Azure/azure-sdk-tools

@KarishmaGhiya
Copy link
Member Author

@willmtemple Can you link the PR/commit in azure-sdk-tools repo when the transition happened?

@KarishmaGhiya
Copy link
Member Author

is it this - https://github.com/Azure/azure-sdk-tools/tree/581c76ceefa357d062ff23f921c92985cc1aa137/tools/eslint-plugin-azure-sdk/docs

@KarishmaGhiya KarishmaGhiya mentioned this issue Jun 24, 2020
Merged
@KarishmaGhiya KarishmaGhiya linked a pull request Jun 25, 2020 that will close this issue
add docs/rules back for eslint-plugin #9705
Merged
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@willmtemple willmtemple

@KarishmaGhiya KarishmaGhiya

Labels
Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add docs/rules back for eslint-plugin KarishmaGhiya/azure-sdk-for-js
2 participants
@willmtemple @KarishmaGhiya