Skip to content

Add article: Authenticate to third-party services#420

Draft
vicroms wants to merge 7 commits intoMicrosoftDocs:mainfrom
vicroms:auth
Draft

Add article: Authenticate to third-party services#420
vicroms wants to merge 7 commits intoMicrosoftDocs:mainfrom
vicroms:auth

Conversation

@vicroms
Copy link
Copy Markdown
Collaborator

@vicroms vicroms commented Oct 31, 2024

No description provided.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 7f3048b:

⚠️ Validation status: warnings

File Status Preview URL Details
vcpkg/consume/third-party-authentication.md ⚠️Warning View Details
vcpkg/TOC.yml ✅Succeeded View
vcpkg/users/authentication.md ✅Succeeded View

vcpkg/consume/third-party-authentication.md

  • Line 42, Column 69: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#azurl' in 'users/assetcaching.md', did you mean '#x-azurl'?
  • Line 56, Column 1: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#AUTHORIZATION_TOKEN' in 'maintainers/functions/vcpkg_from_github.md'.
  • Line 58, Column 1: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#AUTHORIZATION_TOKEN' in 'maintainers/functions/vcpkg_from_gitlab.md'.
  • Line 66, Column 67: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#github-actions-cache' in 'reference/binarycaching.md'.
  • Line 73, Column 18: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#github-packages' in 'reference/binarycaching.md'.

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 Markdown
Contributor

@Thomas1664 Thomas1664 left a comment

Choose a reason for hiding this comment

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

I do not like the new article because it just acts like a „table of contents“. Users have to jump around in the documentation to find what they are looking for. Obviously, this assumes users know what they’re looking for. IMO rather than linking all over the place from this article, all the other articles should link to the new article which should provide the actual information.

Please also notice the warnings on wrong links.

Comment thread vcpkg/consume/third-party-authentication.md Outdated
Comment thread vcpkg/consume/third-party-authentication.md Outdated
Comment thread vcpkg/consume/third-party-authentication.md Outdated
@vicroms vicroms marked this pull request as draft November 4, 2024 01:54
@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

Comment thread vcpkg/concepts/asset-caching.md Outdated
Comment thread vcpkg/concepts/asset-caching.md Outdated

Asset caching can help with these common development scenarios:
Asset caching allows you to configure alternative download locations (caches) to acquire assets. When enabled, vcpkg first
attempst to acquire assets from any configured cache location, and falls back to the original download if no cached asset
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

attempts

Comment thread vcpkg/concepts/asset-caching.md Outdated
Comment on lines +22 to +24
* Reducing dependency from external networks. Possibly, also reducing download times.
* Mirroring assets in trusted locations for air-gapped environments.
* Maintaining continuity of business if assets hosted by third-parties are changed or unavailable.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* Reducing dependency from external networks. Possibly, also reducing download times.
* Mirroring assets in trusted locations for air-gapped environments.
* Maintaining continuity of business if assets hosted by third-parties are changed or unavailable.
* Reducing download times and bandwidth costs.
* Mirroring assets in trusted locations for air-gapped or offline environments.
* Maintaining continuity of business if assets hosted by third-parties are changed or unavailable.

Comment thread vcpkg/concepts/asset-caching.md Outdated
The expected value is a semicolon-delimited list of asset caching sources. Read the [asset caching reference
documentation](../users/assetcaching.md) to learn the configuration syntax.

Example using Azure Blob Storage as an asset cache:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Example using Azure Blob Storage as an asset cache:
### Example using Azure Blob Storage:

Comment thread vcpkg/consume/asset-caching.md Outdated
Comment thread vcpkg/consume/asset-caching.md Outdated

* `clear`, disables any previously configured asset cache
* `x-azurl,file://C:/vcpkg/asset-cache,,readwrite`, sets a filesystem asset cache, located in
* `x-azurl,file://D:/vcpkg/asset-cache,,readwrite`, sets a filesystem asset cache, located in
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* `x-azurl,file://D:/vcpkg/asset-cache,,readwrite`, sets a filesystem asset cache, located in
* `x-azurl,file:///D:/vcpkg/asset-cache,,readwrite`, sets a filesystem asset cache, located in


### 1 - Create a Shared Access Signature Token in the Azure portal

1 - Open the [Azure portal](https://portal.azure.com/#home) and navigate to your container.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Renders as a paragraph, not as a list.

zone_pivot_group_filename: zone-pivot-groups.json
zone_pivot_groups: shell-selections
---
# Authenticate to third-party services
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Consider breaking this into multiple separate articles, because it seems like this article is serving disjoint audiences.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 02f467d:

⚠️ Validation status: warnings

File Status Preview URL Details
vcpkg/consume/third-party-authentication.md ⚠️Warning View Details
vcpkg/consume/asset-caching.md ✅Succeeded View
vcpkg/resources/ado-copy-pat.png ✅Succeeded View
vcpkg/resources/ado-create-pat.png ✅Succeeded View
vcpkg/resources/ado-options-pat.png ✅Succeeded View
vcpkg/resources/connect-to-nuget-feed.png ✅Succeeded View
vcpkg/resources/create-nuget-feed.png ✅Succeeded View
vcpkg/TOC.yml ✅Succeeded View
vcpkg/users/authentication.md ✅Succeeded View

vcpkg/consume/third-party-authentication.md

  • Line 92, Column 45: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#x-azuniversal' in 'reference/binarycaching.md', did you mean '#azuniversal'?
  • Line 135, Column 5: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#github-actions-cache' in 'reference/binarycaching.md'.
  • Line 186, Column 10: [Suggestion: learn-site-link-broken - See documentation] Link '/nuget/consume-packages/consuming-packages-authenticated-feed#security-best-practices-for-managing-credentials' points to a learn site page that doesn't exist. Check the path or URL and update the 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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants