Skip to content
This repository was archived by the owner on Mar 25, 2023. It is now read-only.

Commit 75b0be0

Browse files
committed
Switch docs/website to use "engine" instead of driver. Fix the doc generation script.
1 parent 6b99eee commit 75b0be0

File tree

5 files changed

+17
-7
lines changed

5 files changed

+17
-7
lines changed

docs/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ self-contained binary is available on the [releases page](https://github.com/spl
3131
### Official Splitgraph engine
3232

3333
Use Docker to pull and start the
34-
[engine](https://hub.docker.com/r/splitgraph/driver/):
34+
[engine](https://hub.docker.com/r/splitgraph/engine/):
3535

3636
$ docker run -d \
3737
-e POSTGRES_PASSWORD=supersecure \
3838
-p 5432:5432 \
39-
splitgraph/driver
39+
splitgraph/engine
4040

4141
By default, `sgr` is configured to speak to the engine running on
4242
`localhost:5432` with a superuser account called `sgr` and a password

docs/sgr/miscellaneous.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,24 @@ Initialize a new repository/engine.
5252

5353
### Examples
5454

55-
``sgr init``
55+
`sgr init`
5656

5757
Initializes the current local Splitgraph engine by writing some bookkeeping information.
5858
This is required for the rest of sgr to work.
5959

60+
`sgr init --skip-audit`
61+
62+
Initializes a Splitgraph engine without installing audit triggers: this is useful for engines that aren't
63+
intended to be used for image checkouts.
64+
6065
``sgr init new/repo``
6166

6267
Creates a single image with the hash ``00000...`` in ``new/repo``
6368

69+
### Options
70+
71+
* **`--skip-audit`**:
72+
6473
## cleanup
6574

6675
```sgr cleanup [OPTIONS] ```

docs/sgr/sharing_images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,6 @@ Shows the current upstream for ``my/repo``.
9393

9494
### Options
9595

96-
* **`-s, --set <TEXT FROM_SCHEMA>...`**: Set the upstream to a engine alias + repository
96+
* **`-s, --set <TEXT REPOSITORY>...`**: Set the upstream to a engine alias + repository
9797
* **`-r, --reset`**: Delete the upstream
9898

docs/sgr/splitfile_execution.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Executes ``my_other.splitfile`` with parameters ``PARAM1`` and ``PARAM2`` set to
3131
### Options
3232

3333
* **`-a, --args <TEXT TEXT>...`**: Parameters to be substituted into the Splitfile. All parameters mentioned in the file must be specified in order for the Splitfile to be executed.
34-
* **`-o, --output-repository FROM_SCHEMA`**: Repository to store the result in.
34+
* **`-o, --output-repository REPOSITORY`**: Repository to store the result in.
3535

3636
## rebuild
3737

@@ -59,7 +59,7 @@ out.
5959
### Options
6060

6161
* **`-u, --update`**: Rederive the image against the latest version of all dependencies.
62-
* **`-a, --against IMAGE_SPEC`**: Images to substitute into the reconstructed Splitfile, of the form [NAMESPACE/]REPOSITORY[:HASH_OR_TAG]. Default tag is 'latest'.
62+
* **`-a, --against IMAGE`**: Images to substitute into the reconstructed Splitfile, of the form [NAMESPACE/]REPOSITORY[:HASH_OR_TAG]. Default tag is 'latest'.
6363

6464
## provenance
6565

website/generate_markdown_commandline_reference.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@
77

88
import click
99
import splitgraph.commandline as cmd
10+
from splitgraph.commandline.ingestion import csv_export, csv_import
11+
1012
# Map category to Click commands -- maybe eventually we'll read this dynamically...
11-
from splitgraph.ingestion import csv_export, csv_import
1213

1314
STRUCTURE = {'Image management/creation': ['checkout', 'commit', 'tag', 'import'],
1415
'Image information': ['log', 'diff', 'object', 'show', 'sql', 'status'],

0 commit comments

Comments
 (0)