Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,11 @@ flowchart BT
The website will automatically be regenerated and redeployed whenever a new commit is made on—or merged into—the `main`
branch of _this_ repository. Regeneration includes pulling content from the remote repositories. The regeneration and redeployment process usually takes about three minutes to complete.

This repository does _not_ automatically "see" changes made to remote repositories. In other words,
making a change to one of the upstream repositories will not cause the website to be regenerated and
redeployed. To regenerate and redeploy the website in that situation, you can follow the instructions
in the "Deployment" section of the "[Development](./development.md#deployment)" guide.

## The Home section

The `content/home/` directory contains the source files for the Home section of the website. That directory began as an
Expand Down
22 changes: 22 additions & 0 deletions development.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ as opposed to the content aspect.
* [Runtime section](#runtime-section)
* [Workflow docs](#workflow-docs)
* [Deployment](#deployment)
* [Automatic deployment](#automatic-deployment)
* [Manual deployment](#manual-deployment)
* [Google Analytics](#google-analytics)
<!-- TOC -->

Expand Down Expand Up @@ -100,6 +102,26 @@ The `.github/workflows` directory contains YAML files that we use to configure G
We use GitHub Actions to (a) compile local and remote content into a single website,
and to (b) publish that single website to GitHub Pages.

### Automatic deployment

Whenever a commit is added to the `main` branch of this repository, the website will be regenerated
and redeployed. That happens via the "Deploy to GitHub Pages" GitHub Actions workflow, which is
specified in: `.github/workflows/deploy-to-gh-pages.yml`

### Manual deployment

If you want to regenerate and redeploy the website without adding a commit to the `main` branch of
this repository, you can do so by following the steps below:

1. Open the repository's **[Actions](https://github.com/microbiomedata/docs/actions)** tab
2. In the left sidebar, click the GHA workflow names **Deploy to GitHub Pages**
Comment thread
eecavanna marked this conversation as resolved.
Outdated
3. In the upper right corner, click the **Run workflow** button
4. In the **Use workflow from** menu that appears, ensure `main` is selected (that's the default)
5. Click the green **Run workflow** button, which will run the GHA workflow
6. Click on the new GHA workflow run and wait for the **Assemble website** job and
the **Deploy website** to finish successfully (i.e. to have a green checkmark)
Comment thread
eecavanna marked this conversation as resolved.
Outdated
7. Wait approximately 3 minutes, then visit the website and confirm it shows what you expect

## Google Analytics

We use Google Analytics to collect and analyze website traffic. You can search the repository for
Expand Down
Loading