Update doc pages (#35)
* Update and rename Add-Documentation.md to Documentation.md * Delete Improve-Documentation.md * Update Create-and-Submit-PullRequest.md
This commit is contained in:
Родитель
3cae858dc7
Коммит
cde9870fbb
Двоичный файл не отображается.
|
@ -1,9 +0,0 @@
|
|||
Documentation is required when adding, removing, or updating a control or an API. To update the documentation, you must submit a separate Pull Request in the [WindowsCommunityToolkitDocs repository](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs) (use the master branch).
|
||||
|
||||
**Both Pull Requests (code and docs) must be approved by the core team before either one is merged.**
|
||||
|
||||
Make sure to update both Pull Requests with a link to each other.
|
||||
|
||||
If adding a new documentation page:
|
||||
* Copy the [documentation template](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/master/docs/.template.md) and follow the same format.
|
||||
* Update the [Table of Content](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/master/docs/toc.md) to point to the new page
|
|
@ -24,7 +24,7 @@ For every contribution, you must:
|
|||
* Follow the Windows Community Toolkit PR Template
|
||||
* If adding a new feature
|
||||
* Before starting coding, you should open an issue and start discussing with the community to see if your idea/feature is interesting enough.
|
||||
* Add Documentation for the feature, see [[Improving Documentation]]
|
||||
* Add Documentation for the feature, see [[Documentation]]
|
||||
* Add or update a sample for the Sample app
|
||||
* If creating a new sample, create a new icon by following the Thumbnail Style Guide and templates
|
||||
* Add or update unit tests and integration tests, see [[Testing]]
|
||||
|
|
|
@ -1,14 +1,21 @@
|
|||
As the community is always working on improving Windows Community Toolkit and introducing new features, we always make certain that our documentation is also updated and meets the requirement of all the current features. Therefore, improving documentation will be a great way to contribute to this project.
|
||||
Documentation is required when adding, removing, or updating a control or an API. As the community is always working on improving Windows Community Toolkit and introducing new features, we always make certain that our documentation is also updated and meets the requirement of all the current features.
|
||||
|
||||
Currently, all the Windows Community Toolkit Docs are being hosted on [WindowsCommunityToolkitDocs](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs) repository and the [Doc PR template](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/master/.github/PULL_REQUEST_TEMPLATE.md) is being followed by the contributors to propose any changes to update the docs for Windows Community Toolkit.
|
||||
|
||||
### How does the Doc process work?
|
||||
## How does the Doc process work?
|
||||
|
||||
When opening a Pull Request, start by forking [Windows Community Toolkit Docs](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs) repository. Then, based on the type of change you're making you'll need to create a new branch from either the `master` or `dev` branches:
|
||||
|
||||
### Improve Documentation
|
||||
If you have a typo or existing document improvement to an already shipped feature, please base your branch off of the [Master branch](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/tree/master). This will allow us to get the change to the published documentation between releases.
|
||||
|
||||
For documentation regarding any new features, please base your fork off the last updated dev branch. For example: 'dev/7.1.0'
|
||||
### Add Documentation
|
||||
**Note:** Both Pull Requests (code and docs) must be approved by the core team before either one is merged and make sure to update both Pull Requests with a link to each other.
|
||||
|
||||
When adding new documentation page:
|
||||
* Copy the [documentation template](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/master/docs/.template.md) and follow the same format.
|
||||
* Update the [Table of Content](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/master/docs/toc.md) to point to the new page.
|
||||
* Proceed to add the content of new feature and base your fork off the last updated dev branch. For example: 'dev/7.1.0'
|
||||
|
||||
We will merge updates from the current main branch to the latest dev branch to keep it in-sync with any updated changes. We will periodically sync the main branch automatically with the live branch to pick up any changes made over time. When we make a new release, we will integrate the dev branch into the main branch in order to publish documentation for new features.
|
||||
|
||||
|
@ -16,3 +23,4 @@ After following the process above, submit the PR, and depending on the improveme
|
|||
|
||||
- [[Staging review from 'master' branch](https://review.docs.microsoft.com/en-us/windows/communitytoolkit/?branch=master)] **This link is currently only available for Microsoft Employees**
|
||||
- [[Live site from 'live' branch](https://docs.microsoft.com/en-us/windows/communitytoolkit/)]
|
||||
|
|
@ -29,8 +29,7 @@
|
|||
* [[Bug Fixes]] 🐛
|
||||
* [[Feature Requests]] 📫
|
||||
* [[Create and Submit PullRequest]] 🚀
|
||||
* [[Add Documentation]] 📝
|
||||
* [[Improve Documentation]] ♻️
|
||||
* [[Documentation]] 📝
|
||||
* [[Review PR]] 📖
|
||||
* [[Avoid Roadblocks]] 🚧
|
||||
|
||||
|
|
Двоичный файл не отображается.
Загрузка…
Ссылка в новой задаче