Skip to content

Commit 9b24e0d

Browse files
committed
refactor(docs): update references to main branch
1 parent 221338c commit 9b24e0d

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This website provides technical documentation for the `eligibility-server` application, a part of the [`benefits`](https://docs.calitp.org/benefits) application, from the [California Integrated Travel Project (Cal-ITP)](https://www.calitp.org).
44

5-
Documentation for the `dev` (default) branch is available [online](https://docs.calitp.org/eligibility-server).
5+
Documentation for the `main` (default) branch is available [online](https://docs.calitp.org/eligibility-server).
66

77
## Overview
88

docs/configuration/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ If you want to run with different settings, you should:
1414

1515
!!! note
1616

17-
The default settings that will always be loaded are in [eligibility_server/settings.py](https://github.com/cal-itp/eligibility-server/blob/dev/eligibility_server/settings.py)
17+
The default settings that will always be loaded are in [eligibility_server/settings.py](https://github.com/cal-itp/eligibility-server/blob/main/eligibility_server/settings.py)
1818

1919
## Creating a new keypair
2020

docs/deployment/infrastructure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Docker logs can be viewed in the Advanced Tools for the instance. The URL patter
8686

8787
## Making changes
8888

89-
Terraform is [`plan`](https://www.terraform.io/cli/commands/plan)'d when code is pushed to any branch on GitHub, then [`apply`](https://www.terraform.io/cli/commands/apply)'d when merged to `dev`. While other automation for this project is done through GitHub Actions, we use an Azure Pipeline (above) for a couple of reasons:
89+
Terraform is [`plan`](https://www.terraform.io/cli/commands/plan)'d when code is pushed to any branch on GitHub, then [`apply`](https://www.terraform.io/cli/commands/apply)'d when merged to `main`. While other automation for this project is done through GitHub Actions, we use an Azure Pipeline (above) for a couple of reasons:
9090

9191
- Easier authentication with the Azure API using a service connnection
9292
- Log output is hidden, avoiding accidentally leaking secrets

docs/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Starting the Dev Container will run `bin/init.sh`, which runs a command to initi
7171

7272
### Run unit tests
7373

74-
Unit tests are implemented with [`pytest`](https://docs.pytest.org/en/6.2.x/) and can be found in the [`tests/`](https://github.com/cal-itp/eligibility-server/tree/dev/tests) directory in the repository. `pytest` is installed and available to run directly in the devcontainer.
74+
Unit tests are implemented with [`pytest`](https://docs.pytest.org/en/6.2.x/) and can be found in the [`tests/`](https://github.com/cal-itp/eligibility-server/tree/main/tests) directory in the repository. `pytest` is installed and available to run directly in the devcontainer.
7575

7676
The test suite runs against every pull request via a GitHub Action.
7777

docs/releases.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
The `eligibility-server` is published as a Docker image on the GitHub Container Registry. It can be accessed from the [repository package page](https://github.com/cal-itp/eligibility-server/pkgs/container/eligibility-server).
44

5-
Every push to the `dev` (default) branch that changes files relevant to the application builds and updates the `dev` package, via the [`docker-publish`](https://github.com/cal-itp/eligibility-server/blob/dev/.github/workflows/docker-publish.yml) GitHub Action.
5+
Every push to the `main` (default) branch that changes files relevant to the application builds and updates the `dev` package, via the [`docker-publish`](https://github.com/cal-itp/eligibility-server/blob/main/.github/workflows/docker-publish.yml) GitHub Action.
66

77
Every release created also pushes a new package publication.
88

99
## Versions
1010

1111
All versions of the package may be viewed on the [package all versions page](https://github.com/cal-itp/eligibility-server/pkgs/container/eligibility-server/versions).
1212

13-
The `dev` (default) branch is published at the `dev` tag:
13+
The `main` (default) branch is published at the `dev` tag:
1414

15-
The official releases will be tagged with a version number and the `latest` tag.
15+
The official releases will be tagged with a version number and their respective environment (`test`, `prod`) tag.

mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
site_name: "cal-itp/eligibility-server: documentation"
22
site_url: https://docs.calitp.org/eligibility-server
33
repo_url: https://github.com/cal-itp/eligibility-server
4-
edit_uri: edit/dev/docs
4+
edit_uri: edit/main/docs
55

66
theme:
77
name: material

0 commit comments

Comments
 (0)