From 16a8b1e105e6598e4e6112a52439af4baf3a3777 Mon Sep 17 00:00:00 2001 From: Amanda Johnston <90629384+amandaejohnston@users.noreply.github.com> Date: Fri, 13 May 2022 12:46:41 -0500 Subject: [PATCH] chore(templates): clarify process for updating docs (#25286) --- .github/CONTRIBUTING.md | 13 +++++++------ .github/PULL_REQUEST_TEMPLATE.md | 1 + 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 38e85dc9a4..6672ac0cd8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -140,12 +140,13 @@ Before creating a pull request, please read our requirements that explains the m #### Modifying Documentation -1. Locate the `readme.md` file in the component's directory. -2. Modify the documentation **above** the line that says `` in this file. -3. To update any of the auto generated documentation below that line, make the relevant changes in the following places: - - `Usage`: update the component's usage examples in the component's `usage/` directory - - `Properties`, `Events`, or `Methods`: update the component's TypeScript file (`*.tsx`) - - `CSS Custom Properties`: update the component's main Sass file (`*.scss`) +- Changes to manually written documentation should be made in the `ionic-docs` repo: https://github.com/ionic-team/ionic-docs/tree/main/docs + - In your `ionic-docs` PR, please add a link back to the related `ionic-framework` PR. +- Changes to auto generated documentation should be made in the `ionic-framework` repo. These can be done in the same PR as your fix or feature. + - Run `npm run build` and commit all updates to ensure your changes make it into the generated documentation. + - `Usage`: update the component's usage examples in the component's `usage/` directory. + - `Properties`, `Events`, or `Methods`: update the component's TypeScript file (`*.tsx`). + - `CSS Custom Properties`: update the component's main Sass file (`*.scss`). #### Modifying Tests diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c02a4ffacf..de483aceb0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,6 +5,7 @@ Please check if your PR fulfills the following requirements: - [ ] Tests for the changes have been added (for bug fixes / features) - [ ] Docs have been reviewed and added / updated if needed (for bug fixes / features) + - Some docs updates need to be made in the `ionic-docs` repo, in a separate PR. See the [contributing guide](https://github.com/ionic-team/ionic-framework/blob/main/.github/CONTRIBUTING.md#modifying-documentation) for details. - [ ] Build (`npm run build`) was run locally and any changes were pushed - [ ] Lint (`npm run lint`) has passed locally and any fixes were made for failures