Migrating docs to MicrosoftDocs repository #2526
Merged
Conversation
| > NOTE: The documentation is also packaged with the sample app. If there is no network connection, or the documentation is not yet on github, the sample app will use the packaged version | ||
| > NOTE: To test your documentation in the sample app while running in debug mode, the docs repository will need to be cloned in the same folder as this repository and named **WindowsCommunityToolkitDocs**. For exaple, this folder structure works best: |
skendrot
Oct 3, 2018
Contributor
Why not add a submodule instead of requiring users to clone a second repo?
Why not add a submodule instead of requiring users to clone a second repo?
nmetulev
Oct 3, 2018
Author
Contributor
Thought about that, and I'm still not against it if it makes sense. A submodule doesn't automatically get pulled in when doing only git clone and it's not the most discoverable command to do a recursive clone so it will still require additional work. It also seems difficult to keep the head of the submodule updated when trying to merge PRs across repos at the same time (I could be wrong here as I don't have experience with this)
Thought about that, and I'm still not against it if it makes sense. A submodule doesn't automatically get pulled in when doing only git clone and it's not the most discoverable command to do a recursive clone so it will still require additional work. It also seems difficult to keep the head of the submodule updated when trying to merge PRs across repos at the same time (I could be wrong here as I don't have experience with this)
|
This is big. Any current PR need to be updated with this. Let's just make sure they know. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
PR Type
What kind of change does this PR introduce?
What is the current behavior?
The documentation currently lives in two repositories: this and the MicrosoftDocs org. We are currently manually keeping the two synced
What is the new behavior?
The docs folder is removed from this repository and the MicrosoftDocs repository will be the only location where documentation will live. Developers will be required to submit two different PRs when adding, deleting, or updating code.
The Contributing.md and PR Template have been updated with new instructions
Sample app has been updated to use new location
Documentation PR: MicrosoftDocs/WindowsCommunityToolkitDocs#106
PR Checklist
Please check if your PR fulfills the following requirements: