Skip to content

Commit 1cceacb

Browse files
committed
Update index
1 parent 03678f9 commit 1cceacb

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Change log
22

3-
sasquatch-backpack is versioned with [semver](https://semver.org/).
3+
Sasquatch-backpack is versioned with [semver](https://semver.org/).
44

55
Find changes for the upcoming release in the project's [changelog.d directory](https://github.com/lsst-sqre/sasquatch-backpack/tree/main/changelog.d/).
66

docs/index.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,29 @@
22
:html_theme.sidebar_secondary.remove:
33

44
##################
5-
sasquatch-backpack
5+
Sasquatchbackpack
66
##################
77

8-
Sasquatch-backpack is a collection of APIs that feed into sasquatch.
8+
Sasquatchbackpack is a collection of APIs that feed into `sasquatch <https://sasquatch.lsst.io/>`__.
9+
Data from integrated APIs is automatically streamed to sasquatch via cron-job via `Phalanx <https://phalanx.lsst.io/>`__ deployment.
10+
Backpack also features CLI entrypoints for easy local access to integrated APIs (See the `CLI Page <user-guide/cli.html>`__ for details).
911

10-
Install sasquatch-backpack from PyPI:
12+
Install Sasquatch-backpack from PyPI:
1113

1214
.. code-block:: bash
1315
14-
pip install sasquatch-backpack
16+
pip install sasquatchbackpack
1517
16-
The current APIs that run off of sasquatch-backpack are:
18+
.. role:: red
19+
.. role:: green
1720

18-
- USGS Earthquake data (`libcomcat <https://code.usgs.gov/ghsc/esi/libcomcat-python>`__)
21+
**Please note that all CLI interaction with Sasquatch-backpack is done sans hyphen!** (:green:`"sasquatchbackpack"`, not :red:`"sasquatch-backpack"`)
22+
23+
The current APIs that run off of Sasquatch-backpack are:
1924

20-
Sasquatch-backpack also features CLI entrypoints for easy access to integrated APIs. See the `CLI Page <user-guide/cli.html>`__ for details.
25+
- USGS Earthquake data (`libcomcat <https://code.usgs.gov/ghsc/esi/libcomcat-python>`__)
2126

22-
sasquatch-backpack is developed on GitHub at https://github.com/lsst-sqre/sasquatch-backpack.
27+
Sasquatch-backpack is developed on GitHub at https://github.com/lsst-sqre/sasquatch-backpack.
2328

2429
.. toctree::
2530
:hidden:

0 commit comments

Comments
 (0)