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.

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

[docs] Rewrite doc for vcpkg_cmake_configure. Move up into docs/maintainers/. #25255

Merged

Conversation

ras0219-msft
Copy link
Contributor

This is the first docs overhaul PR for a helper function from a port.

A key change I propose for the port-based helpers is to de-segregate them from the "built-in" helpers and instead rely on documentation within the page to guide users on how to consume it. This change accomplishes two goals:

  1. Improve discoverability - All helper functions (built-in + curated catalog) will be findable in the same location, so users don't need to look in multiple places.
  2. Improve usefulness - By including the usage syntax to depend upon the providing port, users have a "one-stop shop" to answer the common scenario of "I was told to use X, how do I do that?".

vicroms
vicroms previously approved these changes Jun 16, 2022
@LilyWangLL LilyWangLL added the category:documentation To resolve the issue, documentation will need to be updated label Jun 16, 2022
@LilyWangLL LilyWangLL added requires:author-response info:internal This PR or Issue was filed by the vcpkg team. labels Jun 16, 2022
@@ -71,7 +71,7 @@
### [vcpkg-cmake](ports/vcpkg-cmake.md)

- [vcpkg\_cmake\_build](ports/vcpkg-cmake/vcpkg_cmake_build.md)
- [vcpkg\_cmake\_configure](ports/vcpkg-cmake/vcpkg_cmake_configure.md)
- [vcpkg\_cmake\_configure](vcpkg_cmake_configure.md)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should these be merged into the list above?

Copy link
Member

Choose a reason for hiding this comment

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

In my opinion, yes

github-actions[bot]
github-actions bot previously approved these changes Jun 17, 2022
@vicroms
Copy link
Member

vicroms commented Jun 23, 2022

LGTM after the minor change I suggested.

github-actions[bot]
github-actions bot previously approved these changes Jun 28, 2022
@ras0219-msft ras0219-msft merged commit 3f71620 into microsoft:master Jun 29, 2022
@ras0219-msft ras0219-msft deleted the dev/roschuma/docs-vcpkg-cmake branch June 29, 2022 14:09
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 info:internal This PR or Issue was filed by the vcpkg team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants