Skip to content

Commit 26b7e6d

Browse files
author
Henry Lee
committed
docs: fix markdown format and add todo comment
1 parent 73bce41 commit 26b7e6d

File tree

3 files changed

+16
-4
lines changed

3 files changed

+16
-4
lines changed

docs/CONTRIBUTING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,20 +48,30 @@ If additional steps are required after merging and deploying (e.g., add new conn
4848

4949
### 7. Wait for the review and merge.
5050

51+
## Login to Airflow Web UI
52+
53+
Ask maintainers for your Airflow account and credentials.
54+
55+
<!--TODO: GitHub or Google OAuth login maybe a good way to reduce maintenance overhead, but it requires more setup. -->
56+
5157
## Convention
5258

5359
### Airflow Dags
60+
5461
- Please refer to [「大數據之路:阿里巴巴大數據實戰」 讀書心得](https://medium.com/@davidtnfsh/%E5%A4%A7%E6%95%B0%E6%8D%AE%E4%B9%8B%E8%B7%AF-%E9%98%BF%E9%87%8C%E5%B7%B4%E5%B7%B4%E5%A4%A7%E6%95%B0%E6%8D%AE%E5%AE%9E%E8%B7%B5-%E8%AE%80%E6%9B%B8%E5%BF%83%E5%BE%97-54e795c2b8c) for naming guidelines.
5562
- Table name convention:
5663
![img](https://miro.medium.com/max/1400/1*bppuEKMnL9gFnvoRHUO8CQ.png)
5764

5865
### Code Formatting
66+
5967
Please run `make format` to ensure your code is properly formatted before committing; otherwise, the CI will fail.
6068

6169
### Commit Message
70+
6271
It is recommended to use [Commitizen](https://commitizen-tools.github.io/commitizen/).
6372

6473
## Release Management (CI/CD)
74+
6575
We use [Python CI] and [Docker Image CI] to ensure our code quality meets specific standards and that Docker images can be published automatically.
6676

6777
When a pull request is created, [Python CI] checks whether the code quality is satisfactory. At the same time, we build a `cache` image using `Dockerfile` and a `test` image with `Dockerfile.test`, which are then pushed to the [GCP Artifact Registry].
@@ -106,4 +116,4 @@ config:
106116
[uv]: https://docs.astral.sh/uv/
107117
[Python CI]: https://github.com/pycontw/pycon-etl/actions/workflows/python.yml
108118
[Docker Image CI]: https://github.com/pycontw/pycon-etl/actions/workflows/dockerimage.yml
109-
[GCP Artifact Registry]: https://cloud.google.com/artifact-registry/
119+
[GCP Artifact Registry]: https://cloud.google.com/artifact-registry/

docs/DEPLOYMENT.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ docker-compose -f ./docker-compose.yml up
3636
### 5. Check whether the services are up
3737

3838
```bash
39-
# For Airflow, the following services should be included:
39+
# For Airflow, the following services should be included:
4040
# * airflow-api-server
4141
# * airflow-dag-processor
4242
# * airflow-scheduler
@@ -48,4 +48,5 @@ docker stats
4848
```
4949

5050
### 6. Login to the service
51-
For security reasons, our Airflow instance is not publicly accessible. You will need an authorized GCP account to perform port forwarding for the webserver and an authorized Airflow account to access it.
51+
52+
For security reasons, our Airflow instance is not publicly accessible. You will need an authorized GCP account to perform port forwarding for the webserver and an authorized Airflow account to access it.

docs/MAINTENANCE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ du -a /var/lib/docker/overlay2 | sort -n -r | head -n 20
1717
### 2. Show the folder size:
1818

1919
```bash
20-
du -hs
20+
du -hs
2121
```
2222

2323
### 3. Delete the large folders identified.
24+
2425
### 4. Check disk space:
2526

2627
```bash

0 commit comments

Comments
 (0)