Skip to content

Commit ee76e1f

Browse files
yarikoptickabilar
andauthored
Various minor tune ups from code review
Co-authored-by: Kabilar Gunalan <[email protected]>
1 parent 3dc1823 commit ee76e1f

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/59_overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The DANDI platform is essentially composed of:
1313
2. **API**: A Django/Resonant-based backend application (hosted on Heroku) that handles the DANDI data model, user authentication, and orchestrates S3 interactions.
1414
3. **Frontend**: A Vue-based web application (hosted on Netlify) for users to browse, search, and manage data in the archive.
1515
4. **Workers**: Celery workers (also on Heroku) for asynchronous tasks such as file checksum calculations, analytics, and housekeeping.
16-
5. **Observability**: Log aggregation and alerting (Heroku logs, optional additional logs), plus Sentry for error-tracking and notifications. TODO(asmacdo) verify
16+
5. **Observability**: Log aggregation and alerting (Heroku logs, optional additional logs), plus Sentry for error-tracking and notifications.
1717
6. **Infrastructure-As-Code**: Terraform scripts that glue everything together—AWS S3 resources, Netlify or domain DNS, Heroku apps, etc.
1818

1919
These services interconnect as follows:

docs/60_initialize_vendors.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ The DANDI ecosystem relies on vendor services to operate. So first you will nee
66

77
- **AWS**: Provides storage buckets, as well as domain management, for resources across the DANDI ecosystem. As well as the services (Kubernetes, etc.) for deploying the JupyterHub.
88

9-
- **GitHub**: Serves as the authentication provider for accounts across the DANDI ecosystem
9+
- **GitHub**: Serves as the authentication provider for accounts across the DANDI ecosystem.
1010

1111
- **Terraform Cloud**: Manages provisioned resources across cloud vendors in a version-controlled manner.
1212

13-
- **Netlify**: Deploys production frontend build, as well as staging previews to assist with frontend development
13+
- **Netlify**: Deploys production frontend build, as well as staging previews to assist with frontend development.
1414

15-
- **Sentry**: Provides observability and monitoring for API events
15+
- **Sentry**: Provides observability and monitoring for API events.
1616

1717
Some services are not yet integrated within the main infrastructure:
1818

docs/62_dandi_cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The DANDI Client provides both a command line interface (CLI) and Python API.
55

66
To reference your DANDI-clone API, [update the URLs reference per each CLI action](https://github.com/dandi/dandi-cli/blob/15196a93310618f8897c7b43444e216bbb094549/dandi/consts.py#L119-L135) and push a PR to the [dandi-cli GitHub repository](https://github.com/dandi/dandi-cli).
77

8-
Here is an example PR of another clone adding to the available instances of `DandiInstance` objects in `dandi-cli`: [see here](https://github.com/dandi/dandi-cli/pull/1527)
8+
Here is an [example PR](https://github.com/dandi/dandi-cli/pull/1527) of another clone adding to the available instances of `DandiInstance` objects in the `dandi-cli`.
99

1010
For example:
1111

@@ -50,7 +50,7 @@ The DANDI Client leverages a tool called [versioneer](https://pypi.org/project/v
5050
Upon merging of a PR into `master`, if the `release` label is attached to the PR
5151
`versioneer` will generate a human-readable CHANGELOG entry, and then push to PyPI the new semantic version. For more details on labeling `dandi-cli` pull requests, see [here](https://github.com/dandi/dandi-cli/blob/master/DEVELOPMENT.md#releasing-with-github-actions-auto-and-pull-requests).
5252

53-
### Versioning-Realted Resources
53+
### Resources
5454
- [PyPI package](https://pypi.org/project/dandi/)
5555
- [Source code](https://github.com/dandi/dandi-cli)
5656
- [Developer instructions](https://github.com/dandi/dandi-cli/blob/master/DEVELOPMENT.md)

0 commit comments

Comments
 (0)