Skip to content

Commit 4142cdb

Browse files
committed
feat: doc update
1 parent 263b0b4 commit 4142cdb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+12
-9124
lines changed

.github/workflows/build-docs.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,17 @@ jobs:
2525
build:
2626
runs-on: ubuntu-latest
2727
steps:
28-
- name: Checkout repository
28+
- name: 🛎️ Checkout repository
2929
uses: actions/checkout@v4
3030

31-
- name: Build docs using Writerside Docker builder
31+
- name: 🏗️ Build docs using Writerside Docker builder
3232
uses: JetBrains/writerside-github-action@v5
3333
with:
3434
instance: ${{ env.INSTANCE }}
3535
artifact: ${{ env.ARTIFACT }}
3636
docker-version: ${{ env.DOCKER_VERSION }}
3737

38-
- name: Save artifact with build results
38+
- name: 📤 Save artifact with build results
3939
uses: actions/upload-artifact@v4
4040
with:
4141
name: docs
@@ -49,13 +49,13 @@ jobs:
4949
if: false
5050
runs-on: ubuntu-latest
5151
steps:
52-
- name: Download artifacts
52+
- name: Download artifacts
5353
uses: actions/download-artifact@v4
5454
with:
5555
name: docs
5656
path: artifacts
5757

58-
- name: Test documentation
58+
- name: 🧪️ Test documentation
5959
uses: JetBrains/writerside-checker-action@v1
6060
with:
6161
instance: ${{ env.INSTANCE }}
@@ -64,18 +64,18 @@ jobs:
6464
needs: [ build ]
6565
runs-on: ubuntu-latest
6666
steps:
67-
- name: Check out the source code
67+
- name: 🛎️ Check out the source code
6868
uses: actions/checkout@v4
6969
with:
7070
fetch-depth: 0
7171
submodules: recursive
7272

73-
- name: Download artifacts
73+
- name: Download artifacts
7474
uses: actions/download-artifact@v4
7575
with:
7676
name: docs
7777

78-
- name: Unzip artifact
78+
- name: 🗜️ Unzip artifact
7979
run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d notesDir
8080

8181
- name: 🚀 Deploy notes
@@ -85,7 +85,7 @@ jobs:
8585
folder: notesDir
8686
target-folder: notes
8787
clean: true
88-
commit-message: 'Deployed notes!'
88+
commit-message: 'Deployed notes!'
8989

9090
# - name: Setup Pages
9191
# uses: actions/configure-pages@v4

Writerside/topics/Readings.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Readings
22

33
<!-- TOC -->
4+
45
* [Readings](#readings)
56
* [Java](#java)
67
* [Happy eyeballs](#happy-eyeballs)
78
* [Database](#database)
9+
810
<!-- TOC -->
911

1012
### Java
@@ -47,3 +49,4 @@
4749
* [Sakila DB](https://github.com/jOOQ/sakila/tree/main/postgres-sakila-db)
4850
* [Chinook PostgreSql](https://github.com/lerocha/chinook-database/blob/master/ChinookDatabase/DataSources/Chinook_PostgreSql.sql)
4951
* [Audit Table Schema](https://gist.github.com/ooredroxoo/b92baba03c30ed87e46227fd08a25c6c)
52+
* Test To be removed

notes/HelpTOC.json

Lines changed: 0 additions & 1 deletion
This file was deleted.

notes/Map.jhm

Lines changed: 0 additions & 1 deletion
This file was deleted.

notes/apple-touch-icon.png

-535 Bytes
Binary file not shown.

notes/config.json

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)