Skip to content

Commit 575286a

Browse files
authored
docs: update staging deployment flow (npm#173)
1 parent 77bc023 commit 575286a

File tree

2 files changed

+9
-15
lines changed

2 files changed

+9
-15
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,8 @@ contribute a change? Great!
2424
filesystem and will reload your content changes immediately.)
2525
5. Once you're happy, commit it and open a pull request at
2626
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
3029
[deploy the site](https://github.com/npm/documentation/actions/workflows/publish.yml).
3130

3231
## Running locally
@@ -205,15 +204,11 @@ adding a new major version to the site.
205204

206205
## Reviewing changes
207206

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).
217212

218213
## Deploying changes
219214

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,8 @@ that generate the site itself.
1919
filesystem and will reload your content changes immediately.)
2020
5. Once you're happy, commit it and open a pull request at
2121
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
2524
[deploy the site](https://github.com/npm/documentation/actions/workflows/publish.yml).
2625

2726
Do you want to know more? Check out our [contributing guide](CONTRIBUTING.md).

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy