docs: update staging deployment flow (#173)
Luke Karrys committed
Aug 17, 2022 at 11:46 UTC
575286a904554f863b0a32c88884b05fb3ec37f8
2 files changed
+9
-15
CONTRIBUTING.md
+7
-12
@@ -24,9 +24,8 @@ contribute a change? Great!
24
filesystem and will reload your content changes immediately.)
25
5. Once you're happy, commit it and open a pull request at
26
https://github.com/npm/documentation.
27
-6. A CI workflow run will publish your PR to the staging documentation
28
- site at https://docs-staging.npmjs.com/.
29
-8. Once the content is reviewed, merge the pull request. That will
27
+6. A CI workflow run will publish your PR to a GitHub Preview Page.
28
+7. Once the content is reviewed, merge the pull request. That will
29
[deploy the site](https://github.com/npm/documentation/actions/workflows/publish.yml).
30
31
## Running locally
@@ -205,15 +204,11 @@ adding a new major version to the site.
204
205
## Reviewing changes
206
208
-The staging docs site (https://docs-staging.npmjs.com/) is published
209
-from a set of GitHub actions workflows. Since it is a separate site
210
-(with a separate GitHub Pages instance), the staging site lives in a
211
-[separate GitHub repository](https://github.com/npm/docs-staging).
212
-As a result when a pull request is opened in _this_ repository, we
213
-send a repository dispatch event to the `docs-staging` repository.
214
-
215
-A GitHub Actions workflow run in that repository will then build the
216
-pull request and publish the staging site for review.
207
+When a pull request is opened or updated the
208
+[GitHub Actions workflow](https://github.com/npm/documentation/actions/workflows/publish.yml)
209
+will deploy a preview to the [`github-pages` environment](https://github.com/npm/documentation/deployments/activity_log?environment=github-pages).
210
+The URL will be reported to the pull request and the status can be checked by looking at the
211
+workflows for the [`pull_request_target` event](https://github.com/npm/documentation/actions/workflows/publish.yml?query=event%3Apull_request_target).
212
213
## Deploying changes
214
README.md
+2
-3
@@ -19,9 +19,8 @@ that generate the site itself.
19
filesystem and will reload your content changes immediately.)
20
5. Once you're happy, commit it and open a pull request at
21
https://github.com/npm/documentation.
22
-6. A CI workflow run will publish your PR to the staging documentation
23
- site at https://docs-staging.npmjs.com/.
24
-8. Once the content is reviewed, merge the pull request. That will
22
+6. A CI workflow run will publish your PR to a GitHub Preview Page.
23
+7. Once the content is reviewed, merge the pull request. That will
24
[deploy the site](https://github.com/npm/documentation/actions/workflows/publish.yml).
25
26
Do you want to know more? Check out our [contributing guide](CONTRIBUTING.md).