Skip to content

Commit

Permalink
adding more description to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MathewBiddle committed Aug 10, 2023
1 parent bc2a208 commit f3b4c47
Showing 1 changed file with 24 additions and 12 deletions.
36 changes: 24 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,31 @@ Leveraged existing resources from https://github.com/noaa-fisheries-integrated-t

The webpages are built from the `website/` directory.

* `Browse_config.json` - configuration for what resources to present on the webpage.
* `create_catalog_landing_page.py` - script to create the browse.html landing page
* `create_tool_landing_page.py` - script to create individual tool landing pages.
* `index.html` - html source for landing page. (links to browse.html created from `create_catalog_landing_page.py`)
* `static/main.css` - css control for website.

| File(s) | Description
|---------------------------------------|---------------------------------------------------------------
| `*_config.json` | configuration for what resources to present on the webpages.
| `create_asset_inventory_page.py` | script to create https://ioos.github.io/ioos_metrics/asset_inventory.html
| `create_gts_atn_page.py` | script to create https://ioos.github.io/ioos_metrics/gts_atn.html
| `create_gts_regional_landing_page.py` | script to create https://ioos.github.io/ioos_metrics/gts_regional.html
| `deploy/index.html` | html source for landing page https://ioos.github.io/ioos_metrics/index.html
| `deploy/static/main.css` | css control for website.

## Development

To create the webpages on your local system
```bash
>cd website

>python create_tool_landing_page.py
2BOX
AcousticThresholds

>git clone https://github.com/ioos/ioos_metrics.git
>cd ioos_metrics/website
>python create_asset_inventory_page.py
>python create_gts_atn_landing_page.py
>python create_gts_regional_landing_page.py
```

All the webpages will be saved to `website/deploy`. You can view the local html files with a web browser for testing.

## Deployment

The website is generated using GitHub Actions and GitHub Pages. The python scripts, referenced above, are ran and the
directory `website/deploy` is then uploaded as an artifact for GitHub Pages to serve as a website.
This process is automatically ran with every push to the `main` branch. See [here](https://github.com/ioos/ioos_metrics/blob/main/.github/workflows/website_create_and_deploy.yml).

0 comments on commit f3b4c47

Please sign in to comment.