Skip to content

MSAL Node documentation updates #30

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

Conversation

cilwerner
Copy link
Collaborator

  • updating links
  • aligning with Learn doc styling

Copy link

Learn Build status updates of commit 79438c0:

⚠️ Validation status: warnings

File Status Preview URL Details
msal-javascript-conceptual/node/brokering.md ⚠️Warning View Details
msal-javascript-conceptual/node/caching.md ⚠️Warning View Details
msal-javascript-conceptual/node/configuration.md ⚠️Warning View Details
msal-javascript-conceptual/node/extensions.md ⚠️Warning View Details
msal-javascript-conceptual/node/faq.md ⚠️Warning View Details
msal-javascript-conceptual/node/key-vault-managed-identity.md ⚠️Warning View Details
msal-javascript-conceptual/node/MIP-caching.md ⚠️Warning View Details
msal-javascript-conceptual/node/performance.md ⚠️Warning View Details
msal-javascript-conceptual/node/request.md ⚠️Warning View Details
msal-javascript-conceptual/node/certificate-credentials.md 💡Suggestion View Details
msal-javascript-conceptual/node/initialize-public-client-application.md 💡Suggestion View Details
msal-javascript-conceptual/node/migration.md 💡Suggestion View Details
msal-javascript-conceptual/node/sni.md 💡Suggestion View Details
msal-javascript-conceptual/node/accounts.md ✅Succeeded View
msal-javascript-conceptual/node/initialize-confidential-client-application.md ✅Succeeded View
msal-javascript-conceptual/node/MIP-migration.md ✅Succeeded n/a (file deleted or renamed)
msal-javascript-conceptual/node/regional-authorities.md ✅Succeeded View

msal-javascript-conceptual/node/brokering.md

  • Line 45, Column 230: [Warning: bookmark-not-found] Cannot find bookmark '#supported-environment' in 'node/brokering.md'.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to acquire tokens from the native token broker.' is duplicated in 'node/brokering.md(3,14)', 'node/configuration.md(3,14)', 'node/initialize-public-client-application.md(3,14)', 'node/key-vault-managed-identity.md(3,14)', 'node/request.md(3,14)'....

msal-javascript-conceptual/node/caching.md

  • Line 117, Column 134: [Warning: file-not-found - See documentation] Invalid file link: '../../../extensions/msal-node-extensions/README.md'.
  • Line 121, Column 24: [Warning: file-not-found - See documentation] Invalid file link: '../../../extensions/msal-node-extensions/README.md'.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to effectively cache tokens in MSAL Node, and use client secrets securely,' is duplicated in 'node/caching.md(3,14)', 'node/extensions.md(3,14)'.

msal-javascript-conceptual/node/configuration.md

  • Line 85, Column 83: [Warning: file-not-found - See documentation] Invalid file link: '../README.md'.
  • Line 86, Column 146: [Warning: file-not-found - See documentation] Invalid file link: '../../msal-common/docs/authority.md'.
  • Line 88, Column 123: [Warning: file-not-found - See documentation] Invalid file link: '../../msal-common/docs/performance.md'.
  • Line 89, Column 114: [Warning: file-not-found - See documentation] Invalid file link: '../../msal-common/docs/performance.md'.
  • Line 90, Column 137: [Warning: file-not-found - See documentation] Invalid file link: '../../msal-common/docs/client-capability.md'.
  • Line 92, Column 184: [Warning: file-not-found - See documentation] Invalid file link: 'aka.ms/msaljs/azure_cloud_instance'.
  • Line 92, Column 460: [Warning: file-not-found - See documentation] Invalid file link: 'msaljs/azure_cloud_instance'.
  • Line 93, Column 265: [Warning: file-not-found - See documentation] Invalid file link: '../../msal-common/docs/authority.md'.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to acquire tokens from the native token broker.' is duplicated in 'node/brokering.md(3,14)', 'node/configuration.md(3,14)', 'node/initialize-public-client-application.md(3,14)', 'node/key-vault-managed-identity.md(3,14)', 'node/request.md(3,14)'....

msal-javascript-conceptual/node/extensions.md

  • Line 2, Column 8: [Warning: duplicate-titles - See documentation] Title 'Microsoft Authentication Extensions for Node - Microsoft Authentication Library for JavaScript' is duplicated in: 'node/extensions.md(2,8), node/MIP-caching.md(2,8)'. Titles must be unique within a docset.
  • Line 16, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Microsoft Authentication Extensions for Node' is duplicated with other articles: 'node/extensions.md(16,1), node/MIP-caching.md(15,1)'. First level headings must be unique within a docset.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to effectively cache tokens in MSAL Node, and use client secrets securely,' is duplicated in 'node/caching.md(3,14)', 'node/extensions.md(3,14)'.

msal-javascript-conceptual/node/faq.md

  • Line 83, Column 225: [Warning: insecure-link - See documentation] Link 'http://aka.ms/s3u' is insecure. Links to Microsoft sites must use 'https' instead of 'http'.
  • Line 99, Column 397: [Warning: file-not-found - See documentation] Invalid file link: '../../../samples/msal-node-samples/b2c-user-flows/README.md'.
  • Line 97, Column 5: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/active-directory-b2c/add-password-reset-policy?pivots=b2c-user-flow#self-service-password-reset-recommended' will be broken in isolated environments. Replace with a relative link.

msal-javascript-conceptual/node/key-vault-managed-identity.md

  • Line 107, Column 45: [Warning: file-not-found - See documentation] Invalid file link: '../../../samples/msal-node-samples/auth-code-key-vault'.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to acquire tokens from the native token broker.' is duplicated in 'node/brokering.md(3,14)', 'node/configuration.md(3,14)', 'node/initialize-public-client-application.md(3,14)', 'node/key-vault-managed-identity.md(3,14)', 'node/request.md(3,14)'....
  • Line 30, Column 56: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/key-vault/general/quick-create-portal#create-a-vault' will be broken in isolated environments. Replace with a relative link.
  • Line 71, Column 7: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: /javascript/api/overview/azure/keyvault-certificates-readme?view=azure-node-latest
  • Line 71, Column 334: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: /javascript/api/overview/azure/identity-readme?view=azure-node-latest

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link

Learn Build status updates of commit 709e036:

⚠️ Validation status: warnings

File Status Preview URL Details
msal-javascript-conceptual/node/configuration.md ⚠️Warning View Details
msal-javascript-conceptual/node/faq.md ⚠️Warning View Details
msal-javascript-conceptual/node/key-vault-managed-identity.md ⚠️Warning View Details
msal-javascript-conceptual/node/performance.md ⚠️Warning View Details
msal-javascript-conceptual/node/request.md ⚠️Warning View Details
msal-javascript-conceptual/node/brokering.md 💡Suggestion View Details
msal-javascript-conceptual/node/caching.md 💡Suggestion View Details
msal-javascript-conceptual/node/certificate-credentials.md 💡Suggestion View Details
msal-javascript-conceptual/node/extensions.md 💡Suggestion View Details
msal-javascript-conceptual/node/initialize-public-client-application.md 💡Suggestion View Details
msal-javascript-conceptual/node/migration.md 💡Suggestion View Details
msal-javascript-conceptual/node/sni.md 💡Suggestion View Details
msal-javascript-conceptual/node/accounts.md ✅Succeeded View
msal-javascript-conceptual/node/initialize-confidential-client-application.md ✅Succeeded View
msal-javascript-conceptual/node/MIP-caching.md ✅Succeeded View
msal-javascript-conceptual/node/MIP-migration.md ✅Succeeded n/a (file deleted or renamed)
msal-javascript-conceptual/node/regional-authorities.md ✅Succeeded View

msal-javascript-conceptual/node/configuration.md

  • Line 85, Column 135: [Warning: file-not-found - See documentation] Invalid file link: '../README.md'.
  • Line 92, Column 184: [Warning: file-not-found - See documentation] Invalid file link: 'aka.ms/msaljs/azure_cloud_instance'.
  • Line 92, Column 392: [Warning: file-not-found - See documentation] Invalid file link: 'msaljs/azure_cloud_instance'.

msal-javascript-conceptual/node/faq.md

  • Line 83, Column 225: [Warning: insecure-link - See documentation] Link 'http://aka.ms/s3u' is insecure. Links to Microsoft sites must use 'https' instead of 'http'.
  • Line 99, Column 397: [Warning: file-not-found - See documentation] Invalid file link: '../../../samples/msal-node-samples/b2c-user-flows/README.md'.
  • Line 97, Column 5: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/active-directory-b2c/add-password-reset-policy?pivots=b2c-user-flow#self-service-password-reset-recommended' will be broken in isolated environments. Replace with a relative link.

msal-javascript-conceptual/node/key-vault-managed-identity.md

  • Line 107, Column 45: [Warning: file-not-found - See documentation] Invalid file link: '../../../samples/msal-node-samples/auth-code-key-vault'.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to acquire tokens from the native token broker.' is duplicated in 'node/brokering.md(3,14)', 'node/initialize-public-client-application.md(3,14)', 'node/key-vault-managed-identity.md(3,14)', 'node/request.md(3,14)', 'node/sni.md(3,14)'.
  • Line 30, Column 56: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/key-vault/general/quick-create-portal#create-a-vault' will be broken in isolated environments. Replace with a relative link.
  • Line 71, Column 7: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: /javascript/api/overview/azure/keyvault-certificates-readme?view=azure-node-latest
  • Line 71, Column 334: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: /javascript/api/overview/azure/identity-readme?view=azure-node-latest
  • Line 73, Column 8: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/cli/azure/install-azure-cli' will be broken in isolated environments. Replace with a relative link.
  • Line 79, Column 21: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: /javascript/api/overview/azure/identity-readme?view=azure-node-latest
  • Line 117, Column 56: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview#how-a-system-assigned-managed-identity-works-with-an-azure-vm' will be broken in isolated environments. Replace with a relative link.
  • Line 121, Column 30: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/app-service/overview-managed-identity?context=%2Fazure%2Factive-directory%2Fmanaged-identities-azure-resources%2Fcontext%2Fmsi-context&tabs=dotnet' will be broken in isolated environments. Replace with a relative link.
  • Line 149, Column 27: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/app-service/overview-managed-identity?tabs=dotnet#add-a-system-assigned-identity' will be broken in isolated environments. Replace with a relative link.
  • Line 162, Column 27: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/samples/azure-samples/app-service-msi-keyvault-dotnet/keyvault-msi-appservice-sample/' will be broken in isolated environments. Replace with a relative link.
  • Line 179, Column 3: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/key-vault/general/developers-guide' will be broken in isolated environments. Replace with a relative link.
  • Line 180, Column 3: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview' will be broken in isolated environments. Replace with a relative link.
  • Line 181, Column 3: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials' will be broken in isolated environments. Replace with a relative link.
  • Line 182, Column 3: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/archive/blogs/kaushal/various-ssltls-certificate-file-typesextensions' will be broken in isolated environments. Replace with a relative link.

msal-javascript-conceptual/node/performance.md

  • Line 33, Column 215: [Warning: file-not-found - See documentation] Invalid file link: '../../../samples/msal-node-samples/custom-INetworkModule-and-network-tracing/'.

msal-javascript-conceptual/node/request.md

  • Line 251, Column 84: [Warning: file-not-found - See documentation] Invalid file link: 'response.md'.
  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to acquire tokens from the native token broker.' is duplicated in 'node/brokering.md(3,14)', 'node/initialize-public-client-application.md(3,14)', 'node/key-vault-managed-identity.md(3,14)', 'node/request.md(3,14)', 'node/sni.md(3,14)'.

msal-javascript-conceptual/node/brokering.md

  • Line 3, Column 14: [Suggestion: duplicate-descriptions - See documentation] Attribute 'description' with value 'Learn how to acquire tokens from the native token broker.' is duplicated in 'node/brokering.md(3,14)', 'node/initialize-public-client-application.md(3,14)', 'node/key-vault-managed-identity.md(3,14)', 'node/request.md(3,14)', 'node/sni.md(3,14)'.

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link

Learn Build status updates of commit 8bb0184:

⚠️ Validation status: warnings

File Status Preview URL Details
msal-javascript-conceptual/node/configuration.md ⚠️Warning View Details
msal-javascript-conceptual/node/certificate-credentials.md 💡Suggestion View Details
msal-javascript-conceptual/node/accounts.md ✅Succeeded View
msal-javascript-conceptual/node/brokering.md ✅Succeeded View
msal-javascript-conceptual/node/caching.md ✅Succeeded View
msal-javascript-conceptual/node/extensions.md ✅Succeeded View
msal-javascript-conceptual/node/faq.md ✅Succeeded View
msal-javascript-conceptual/node/initialize-confidential-client-application.md ✅Succeeded View
msal-javascript-conceptual/node/initialize-public-client-application.md ✅Succeeded View
msal-javascript-conceptual/node/key-vault-managed-identity.md ✅Succeeded View
msal-javascript-conceptual/node/migration.md ✅Succeeded View
msal-javascript-conceptual/node/MIP-caching.md ✅Succeeded View
msal-javascript-conceptual/node/MIP-migration.md ✅Succeeded n/a (file deleted or renamed)
msal-javascript-conceptual/node/performance.md ✅Succeeded View
msal-javascript-conceptual/node/regional-authorities.md ✅Succeeded View
msal-javascript-conceptual/node/request.md ✅Succeeded View
msal-javascript-conceptual/node/sni.md ✅Succeeded View

msal-javascript-conceptual/node/configuration.md

  • Line 92, Column 474: [Warning: file-not-found - See documentation] Invalid file link: 'msaljs/azure_cloud_instance'.

msal-javascript-conceptual/node/certificate-credentials.md

  • Line 45, Column 76: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: /powershell/module/pki/new-selfsignedcertificate?view=windowsserver2022-ps
  • Line 173, Column 45: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/dotnet/framework/wcf/feature-details/how-to-view-certificates-with-the-mmc-snap-in' will be broken in isolated environments. Replace with a relative link.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link

Copy link

Learn Build status updates of commit c78a767:

✅ Validation status: passed

File Status Preview URL Details
msal-javascript-conceptual/node/accounts.md ✅Succeeded View
msal-javascript-conceptual/node/brokering.md ✅Succeeded View
msal-javascript-conceptual/node/caching.md ✅Succeeded View
msal-javascript-conceptual/node/caching-in-extensions.md ✅Succeeded View
msal-javascript-conceptual/node/certificate-credentials.md ✅Succeeded View
msal-javascript-conceptual/node/configuration.md ✅Succeeded View
msal-javascript-conceptual/node/extensions.md ✅Succeeded View
msal-javascript-conceptual/node/faq.md ✅Succeeded View
msal-javascript-conceptual/node/initialize-confidential-client-application.md ✅Succeeded View
msal-javascript-conceptual/node/initialize-public-client-application.md ✅Succeeded View
msal-javascript-conceptual/node/initialize-v1-v2-client-apps.md ✅Succeeded View
msal-javascript-conceptual/node/key-vault-managed-identity.md ✅Succeeded View
msal-javascript-conceptual/node/migration.md ✅Succeeded View
msal-javascript-conceptual/node/MIP-caching.md ✅Succeeded n/a (file deleted or renamed)
msal-javascript-conceptual/node/MIP-initialize-client-apps-v2-v1.md ✅Succeeded n/a (file deleted or renamed)
msal-javascript-conceptual/node/MIP-migration.md ✅Succeeded n/a (file deleted or renamed)
msal-javascript-conceptual/node/performance.md ✅Succeeded View
msal-javascript-conceptual/node/regional-authorities.md ✅Succeeded View
msal-javascript-conceptual/node/request.md ✅Succeeded View
msal-javascript-conceptual/node/sni.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@cilwerner cilwerner merged commit 9ffd1d9 into MicrosoftDocs:consolidated-msal.js-docs Dec 14, 2023
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.

1 participant