928pjy / vscode-docs-build

VS Code extension to provide local build and validation experience for Docs repository.

Docs Validation

This extension enables you to run build validation on a Docs conceptual or Learn repo at author time in VS Code. This means you can make sure your repo is free of validation issues before making a pull request.

Prerequisites

• Install git.
• Clone your Docs or Learn repo locally in VS Code.
• All files in the repo must be saved.

How to use the Docs Validation extension

Full-repository validation

1. Open a Docs conceptual or Learn repo in VS Code with the extension installed.
2. For the first time you use the extension, you will be asked to choose your user type between Microsoft employee and Public contributor before you can use full-repository validation.
3. For Microsoft employee, you are required to sign in before using full-repository validation. You can click Docs Validation on the status bar then click Sign in from the drop-down menu to sign in.
4. After signing in, you can trigger a validation by clicking Validate when prompted. You can also click Docs Validation on the status bar then click Validate from the drop-down menu, or by right-clicking any file in the repo and selecting Validate this repository.
5. Build validation will run locally and all results will be output to the Problems pane.

Note: The first time you validate a repo, all the Docs build dependencies will be fetched and cached locally. Subsequent validation runs will be faster.

Real-time validation

1. Open a Docs conceptual or Learn repo in VS Code with the extension installed.
2. For the first time you use the extension, you will be asked to choose your user type between Microsoft employee and Public contributor before you can use real-time validation.
3. The real-time validation is disabled by default, you can enable it in the extension settings (Go to Settings -> Docs Validation -> Check Real-time Validation: Automatically Enable). You will be asked to reload the extension after you enable real-time validation.

4. For Microsoft employee, the extension will check your sign-in status before real-time validation starts to work. If you haven't signed in or your credential expired, you will be asked to sign in. After sign-in succeeds, real-time validation will start automatically.
5. With real-time validation enabled, you will see validation issues (if any) while you are working on the repository (eg. modifying files, creating files and deleting files etc.).

Known issues

Inconsistent results between Docs Build validation and full-repository validation.

• bookmark-not-found: The rendering information required to validate bookmarks in schema-based content isn't available publicly, so if you aren't signed in as a Microsoft employee you might not get all broken bookmark results.
• author-not-found and ms-author-invalid: These validations require external API calls that aren't supported locally at this time, so no results will be returned for them.

Inconsistent results between real-time validation and full-repository validation.

These inconsistent results mainly come from two situations: the currently edited file needs validation results from other files and the currently edited file affects other files' validation results. The real-time validation now will only validates the open files. Therefore, some inconsistent results will show when the files related to these two situations are not opened.

Inconsistent results caused by the currently edited file needs validation results from other files:

• publish-url-conflict
• output-path-conflict
• Content or Metadata uniqueness
  • duplicate-uid
  • xref-property-conflict
  • moniker-overlapping
  • duplicate-title
  • altText-duplicate
  • duplicate-h1
  • ...
• bookmark-not-found
• Validation on hierarchy (for example unit-no-module-parent)

Inconsistent results caused by the currently edited file affects other files' validation results:

• xref-not-found
• bookmark-not-found
• circular-reference
• include-not-found
• file-not-found

Other situations:

• Pull-request-only suggestions will be ignored by full-repository validation but will be reported by real-time validation.
• Include files will not be validated before you open any file includes them.
• .openpublishing.redirection.json will not be validated before you open any content file (.md or .yml).

Note: Validation is not available currently for workspaces with multiple folders.

Troubleshooting

You might encounter the following issues when using the extension.

Clone template repository or dependencies failed

When your validation fails with some error message like:

fatal: unable to access 'https://github.com/Microsoft/templates.docs.msft/': The requested URL returned error: 403
git-clone-failed Failure to clone the repository `https://github.com/Microsoft/templates.docs.msft#master`. This could be caused by an incorrect repository URL, please verify the URL on the Docs Portal (https://ops.microsoft.com). This could also be caused by not having the proper permission the repository, please confirm that the GitHub group/team that triggered the build has access to the repository.
Restore done in 11.77s

  1 Error(s), 0 Warning(s), 0 Suggestion(s)
Error: running 'docfx restore' failed with exit code: 1

Please try the following solutions:

1. Make sure you can access this repository https://github.com/Microsoft/templates.docs.msft on GitHub, if not, please join the Microsoft org by the this website, after that, try again.

2. Try to clone the template repository in a separated terminal by running the following command:

   $ git clone https://github.com/Microsoft/templates.docs.msft

3. If you have enabled 2FA on GitHub and you run into the following errors when you clone the repository, please follow these instructions.

   Cloning into 'templates.docs.msft'...
   Username for 'https://github.com': 928PJY
   Password tor 'https: //[email protected]':
   remote: Invalid username or password.
   fatal: Authentication failed for https://github. com/Microsoft/templates.docs.msft/'

4. GitHub has recently enabled SSO on Microsoft-owned organizations. If you see the below errors, please follow the instructions there to enable SSO on your token so that local validation can pass through.

   fatal: unable to access 'https://github.com/Microsoft/templates.docs.msft/': The requested URL returned error: 403
   remote: The `microsoft' organization has enabled or enforced SAML SSO. To access
   remote: this repository, visit https://github.com/enterprises/microsoftopensource/sso?authorization_request=AEJANEWOPPW6YTNW5TYNW2K7OBDR3A5PN5ZGOYLONF5GC5DJN5XF62LEZYAF32PCVVRXEZLEMVXHI2LBNRPWSZGODVDHWBVPMNZGKZDFNZ2GSYLML52HS4DFVNHWC5LUNBAWGY3FONZQ

License

MIT

Issue

File a issue

How to Contribute

Contribution guideline

All contributions are welcome!