Skip to content

[docs] Fix broken links and generate documentation for vcpkg-gn#24764

Merged
BillyONeal merged 3 commits intomicrosoft:masterfrom
ras0219-msft:dev/roschuma/docs-fix-links
May 20, 2022
Merged

[docs] Fix broken links and generate documentation for vcpkg-gn#24764
BillyONeal merged 3 commits intomicrosoft:masterfrom
ras0219-msft:dev/roschuma/docs-fix-links

Conversation

@ras0219-msft
Copy link
Contributor

@ras0219-msft ras0219-msft commented May 18, 2022

This PR addresses all broken links found by vcpkg/vcpkg.github.io#70, as well as a few new ones added by my recent documentation PRs.

We also have added a helper port vcpkg-gn that wasn't being indexed; I added it to regenerate.ps1.

Depends on vcpkg/vcpkg.github.io#71 to be merged first, then the website SHA needs to be updated to a commit on the main branch.

@LilyWangLL LilyWangLL added the category:documentation To resolve the issue, documentation will need to be updated label May 18, 2022
@ras0219-msft ras0219-msft marked this pull request as draft May 18, 2022 22:04
@ras0219-msft ras0219-msft force-pushed the dev/roschuma/docs-fix-links branch from 841eabb to 1186bd9 Compare May 18, 2022 22:06
@ras0219-msft ras0219-msft force-pushed the dev/roschuma/docs-fix-links branch from 1186bd9 to 6a6c87f Compare May 18, 2022 22:17
@ras0219-msft ras0219-msft force-pushed the dev/roschuma/docs-fix-links branch from 6a6c87f to f392253 Compare May 18, 2022 22:32
@ras0219-msft ras0219-msft force-pushed the dev/roschuma/docs-fix-links branch from f392253 to cab59eb Compare May 18, 2022 22:47
@ras0219-msft ras0219-msft force-pushed the dev/roschuma/docs-fix-links branch from cab59eb to 860c710 Compare May 18, 2022 22:48
@ras0219-msft ras0219-msft force-pushed the dev/roschuma/docs-fix-links branch from 860c710 to 1710347 Compare May 18, 2022 22:52
@ras0219-msft ras0219-msft force-pushed the dev/roschuma/docs-fix-links branch from 1710347 to 0246eef Compare May 18, 2022 22:59
@ras0219-msft ras0219-msft force-pushed the dev/roschuma/docs-fix-links branch from 0246eef to 2fddada Compare May 18, 2022 23:05
@ras0219-msft ras0219-msft force-pushed the dev/roschuma/docs-fix-links branch from 2fddada to 40a97dd Compare May 18, 2022 23:06
@ras0219-msft ras0219-msft marked this pull request as ready for review May 19, 2022 22:13
We would like to eventually support downloading precompiled binaries, similar to other system package managers.

In a corporate scenario, we currently recommend building the libraries once and distributing the entire vcpkg root directory to everyone else on the project through some raw file transport such as a network share or HTTP host. See the [`export`](../users/buildsystems/integration.md#export) command.
In a corporate scenario, we currently recommend building the libraries once and distributing the entire vcpkg root directory to everyone else on the project through some raw file transport such as a network share or HTTP host. See the [`export` command](../users/buildsystems/export-command.md).
Copy link
Member

Choose a reason for hiding this comment

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

I know this PR is just fixing broken links, but we should really update this to suggest binary caching (and probably update other items in our FAQ).

@BillyONeal BillyONeal merged commit 292067a into microsoft:master May 20, 2022
@BillyONeal
Copy link
Member

Thanks!

@ras0219-msft ras0219-msft deleted the dev/roschuma/docs-fix-links branch May 20, 2022 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

category:documentation To resolve the issue, documentation will need to be updated

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants