From a771bfe7e31371374437ae3012a8ce6e52686823 Mon Sep 17 00:00:00 2001 From: harupy Date: Tue, 9 Nov 2021 19:55:35 +0900 Subject: [PATCH 1/4] Add how to preview documentation on PR template Signed-off-by: harupy --- .github/pull_request_template.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 905225f72f6a4..21bdf9e595f95 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,6 +6,19 @@ (Details) +## Does this PR affect the documentation? + +- [ ] No. You can skip the rest of this section. +- [ ] Yes. Make sure the affected pages / sections render correctly by following the steps below. + +Steps: + +1. Make sure the status of the `ci/circleci: build_doc` check is successful. If no, fix it. +2. Click `Details` to open the job page of CircleCI. +3. Click the `Artifacts` tab. +4. Click `docs/build/html/index.html`. +5. Find the affect pages / sections and make sure they render correctly. + ## Release Notes ### Is this a user-facing change? From 5823847763a62eb77b633a17b0525ad3e97ca602 Mon Sep 17 00:00:00 2001 From: harupy Date: Tue, 9 Nov 2021 20:19:47 +0900 Subject: [PATCH 2/4] fix Signed-off-by: harupy --- .github/pull_request_template.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 21bdf9e595f95..1745a5cb6f0af 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -13,11 +13,12 @@ Steps: -1. Make sure the status of the `ci/circleci: build_doc` check is successful. If no, fix it. -2. Click `Details` to open the job page of CircleCI. +1. Check the status of the `ci/circleci: build_doc` check. If it's successful, proceed to the + next step, otherwise fix it. +2. Click `Details` on the right to open the job page of CircleCI. 3. Click the `Artifacts` tab. 4. Click `docs/build/html/index.html`. -5. Find the affect pages / sections and make sure they render correctly. +5. Find the affected pages / sections and make sure they render correctly. ## Release Notes From 2e561ccc081fe7bc4e1e92b8c50e866b3b1df886 Mon Sep 17 00:00:00 2001 From: harupy Date: Tue, 9 Nov 2021 22:02:29 +0900 Subject: [PATCH 3/4] use change Signed-off-by: harupy --- .github/pull_request_template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1745a5cb6f0af..85c2b8fd6bdbe 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,10 +6,10 @@ (Details) -## Does this PR affect the documentation? +## Does this PR change the documentation? - [ ] No. You can skip the rest of this section. -- [ ] Yes. Make sure the affected pages / sections render correctly by following the steps below. +- [ ] Yes. Make sure the changed pages / sections render correctly by following the steps below. Steps: @@ -18,7 +18,7 @@ Steps: 2. Click `Details` on the right to open the job page of CircleCI. 3. Click the `Artifacts` tab. 4. Click `docs/build/html/index.html`. -5. Find the affected pages / sections and make sure they render correctly. +5. Find the changed pages / sections and make sure they render correctly. ## Release Notes From 37ce7187773450caac6c0f89df4686d08540a6ee Mon Sep 17 00:00:00 2001 From: harupy Date: Tue, 9 Nov 2021 23:43:01 +0900 Subject: [PATCH 4/4] remove steps Signed-off-by: harupy --- .github/pull_request_template.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 85c2b8fd6bdbe..0ff2c270a8d40 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,8 +11,6 @@ - [ ] No. You can skip the rest of this section. - [ ] Yes. Make sure the changed pages / sections render correctly by following the steps below. -Steps: - 1. Check the status of the `ci/circleci: build_doc` check. If it's successful, proceed to the next step, otherwise fix it. 2. Click `Details` on the right to open the job page of CircleCI.