Skip to content

Commit 54d3dda

Browse files
committed
docs: remove manually built table of content
1 parent 317a48f commit 54d3dda

File tree

1 file changed

+5
-15
lines changed

1 file changed

+5
-15
lines changed

docs/README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,7 @@
55

66
Using Airflow to implement our ETL pipelines.
77

8-
## Table of Contents
9-
10-
- [Prerequisites](#prerequisites)
11-
- [Installation](#installation)
12-
- [Configuration](#configuration)
13-
- [BigQuery (Optional)](#bigquery-optional)
14-
- [Running the Project](#running-the-project)
15-
- [Local Environment with Docker](#local-environment-with-docker)
16-
- [Production](#production)
17-
- [Contact](#contact)
18-
19-
---
8+
[TOC]
209

2110
## Prerequisites
2211

@@ -26,6 +15,7 @@ Using Airflow to implement our ETL pipelines.
2615
- [uv]
2716

2817
## Installation
18+
2919
We use [uv] to manage dependencies and virtual environment.
3020

3121
Below are the steps to create a virtual environment using [uv]:
@@ -69,8 +59,8 @@ deactivate
6959
### BigQuery (Optional)
7060

7161
- Set up the Authentication for GCP: <https://googleapis.dev/python/google-api-core/latest/auth.html>
72-
- After running `gcloud auth application-default login`, you will get a credentials.json file located at `$HOME/.config/gcloud/application_default_credentials.json`.
73-
- Run `export GOOGLE_APPLICATION_CREDENTIALS="/path/to/keyfile.json"` if you have it.
62+
- After running `gcloud auth application-default login`, you will get a credentials.json file located at `$HOME/.config/gcloud/application_default_credentials.json`.
63+
- Run `export GOOGLE_APPLICATION_CREDENTIALS="/path/to/keyfile.json"` if you have it.
7464
- `service-account.json`: Please contact @david30907d via email or Discord. You do not need this json file if you are running the sandbox staging instance for development.
7565

7666
## Running the Project
@@ -111,6 +101,7 @@ make down-dev
111101
> The difference between production and dev/test compose files is that the dev/test compose file uses a locally built image, while the production compose file uses the image from Docker Hub.
112102
113103
#### Use images from Artifacts
104+
114105
If you are an authorized maintainer, you can pull the image from the [GCP Artifact Registry].
115106

116107
Docker client must be configured to use the [GCP Artifact Registry].
@@ -132,7 +123,6 @@ Available tags:
132123
- `staging`: when pushing to the staging environment
133124
- `latest`: when pushing to the production environment
134125

135-
136126
## Contact
137127

138128
[PyCon TW Volunteer Data Team - Discord](https://discord.com/channels/752904426057892052/900721883383758879)

0 commit comments

Comments
 (0)