Skip to content

Commit

Permalink
Update docs to use "default" and "build-configs" dirs (#47)
Browse files Browse the repository at this point in the history
This commit updates the READMEs in the ingest and phylogenetic and to reflect
changes in a previous commit cd95122
  • Loading branch information
j23414 authored Mar 7, 2024
1 parent a91e575 commit dee6999
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions ingest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This will produce two files (within the `ingest` directory):
Run the complete ingest pipeline and upload results to AWS S3 with

```sh
nextstrain build . --configfiles config/config.yaml config/optional.yaml
nextstrain build . --configfiles defaults/config.yaml defaults/optional.yaml
```

### Adding new sequences not from GenBank
Expand All @@ -57,12 +57,12 @@ Do the following to include sequences from static FASTA files.
!ingest/data/{file-name}.ndjson
```

3. Add the `file-name` (without the `.ndjson` extension) as a source to `ingest/config/config.yaml`. This will tell the ingest pipeline to concatenate the records to the GenBank sequences and run them through the same transform pipeline.
3. Add the `file-name` (without the `.ndjson` extension) as a source to `ingest/defaults/config.yaml`. This will tell the ingest pipeline to concatenate the records to the GenBank sequences and run them through the same transform pipeline.

## Configuration

Configuration takes place in `config/config.yaml` by default.
Optional configs for uploading files and Slack notifications are in `config/optional.yaml`.
Configuration takes place in `defaults/config.yaml` by default.
Optional configs for uploading files and Slack notifications are in `defaults/optional.yaml`.

### Environment Variables

Expand Down
2 changes: 1 addition & 1 deletion phylogenetic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Alternatively, you can run the build using the
example data provided in this repository. To run the build by copying the
example sequences into the `data/` directory, use the following:

nextstrain build . --configfile profiles/ci/profiles_config.yaml
nextstrain build . --configfile build-configs/ci/profiles_config.yaml

[Nextstrain]: https://nextstrain.org
[augur]: https://docs.nextstrain.org/projects/augur/en/stable/
Expand Down

0 comments on commit dee6999

Please sign in to comment.