Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix various outdated links in READMEs #3130

Merged
merged 1 commit into from
Nov 21, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/README.md
Original file line number Diff line number Diff line change
@@ -25,7 +25,7 @@ Workflows prefixed with `service-` deal with Kubernetes deployments.
- `service-release-diff.yml` renders kubectl diffs on PRs targeting release branches
- `service-release-channel.yml` deploys to a given channel (i.e. environment) on updates to a release branch

Some of these workflows use hologit or invoke. See the READMEs in [.holo](../.holo) and [ci](../ci) for documentation regarding hologit and invoke, respectively.
Some of these workflows use hologit or invoke. See the READMEs in [.holo](../../.holo) and [ci](../../ci) for documentation regarding hologit and invoke, respectively.

## GitOps

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ Documentation for this codebase lives at [docs.calitp.org/data-infra](https://do

This repository pre-commit hooks to format code, including black. To install
pre-commit locally, run `pip install pre-commit` & `pre-commit install`
in the root of the repo. There is a [GitHub Action](./github/workflows/lint.yml)
in the root of the repo. There is a [GitHub Action](./.github/workflows/lint.yml)
that runs pre-commit on all files, not just changed ones. sqlfluff is currently
disabled in the CI run due to flakiness, but it will still lint any SQL files
you attempt to commit locally.
2 changes: 1 addition & 1 deletion airflow/README.md
Original file line number Diff line number Diff line change
@@ -84,4 +84,4 @@ docker-compose run airflow tasks test unzip_and_validate_gtfs_schedule_hourly va

## Deploying to production

We have a [GitHub Action](../.github/workflows/deploy_airflow_dags.yml) that runs when PRs touching this directory merge to the `main` branch. The GitHub Action updates requirements and syncs the [DAGs](./airflow/dags) and [plugins](./airflow/plugins) directories to the bucket that Composer watches for code/data to parse. As of 2023-07-18, this bucket is `us-west2-calitp-airflow2-pr-171e4e47-bucket`. Our production Composer instance is called [calitp-airflow2-prod](https://console.cloud.google.com/composer/environments/detail/us-west2/calitp-airflow2-prod/monitoring); its configuration (including worker count, Airflow config overrides, and environment variables) is manually managed through the web console.
We have a [GitHub Action](../.github/workflows/deploy_airflow.yml) that runs when PRs touching this directory merge to the `main` branch. The GitHub Action updates requirements and syncs the [DAGs](./dags) and [plugins](./plugins) directories to the bucket that Composer watches for code/data to parse. As of 2023-07-18, this bucket is `us-west2-calitp-airflow2-pr-171e4e47-bucket`. Our production Composer instance is called [calitp-airflow2-prod](https://console.cloud.google.com/composer/environments/detail/us-west2/calitp-airflow2-prod/monitoring); its configuration (including worker count, Airflow config overrides, and environment variables) is manually managed through the web console.
2 changes: 1 addition & 1 deletion packages/calitp-data-infra/README.md
Original file line number Diff line number Diff line change
@@ -11,5 +11,5 @@ download Airflow DAG and the GTFS RT archiver.
## Testing and publishing

This repository should pass mypy and other static checkers, and has a small
number of tests. These checks are executed in [GiHub Actions](../../.github/workflows/build-calitp-data-infra.yml) and the package will
number of tests. These checks are executed in [GitHub Actions](../../.github/workflows/build-calitp-data-infra.yml) and the package will
eventually be published to pypi on merge.
2 changes: 1 addition & 1 deletion services/gtfs-rt-archiver-v3/README.md
Original file line number Diff line number Diff line change
@@ -43,7 +43,7 @@ Both of these tasks can fire if the archiver is only partially degraded, but the
We log errors and exceptions (both caught and uncaught) to our [Sentry instance](https://sentry.calitp.org/) via the [Python SDK for Sentry](https://github.com/getsentry/sentry-python). Common problems include:

- Failure to connect to Redis following a node upgrade; this is typically fixed by [restarting the archiver](#restarting-the-archiver).
- `RTFetchException`, a custom class specific to failures during feed download; these can be provider-side (i.e. the agency/vendor) or consumer-side (i.e. us) and are usually fixed (if possible) by [changing download configurations](#fixing-download-configurations). Common examples (and HTTP error code if relevant) include:
- `RTFetchException`, a custom class specific to failures during feed download; these can be provider-side (i.e. the agency/vendor) or consumer-side (i.e. us) and are usually fixed (if possible) by [changing download configurations](#changing-download-configurations). Common examples (and HTTP error code if relevant) include:
- Missing or invalid authentication (401/403)
- Changed URLs (404)
- Intermittent outages/errors (may be a ConnectionError or a 500 response)