Skip to content

Commit a83435f

Browse files
committed
Refactor: move docs to wiki repo, remove redoc workflow
1 parent a83e319 commit a83435f

File tree

5 files changed

+1
-190
lines changed

5 files changed

+1
-190
lines changed

.github/workflows/docs.yml

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,54 +4,14 @@ on:
44
push:
55
branches:
66
- main
7-
paths:
8-
- 'openapi.yaml'
97
pull_request:
108
branches:
119
- main
12-
paths:
13-
- 'openapi.yaml'
1410

1511
jobs:
16-
build-docs:
17-
runs-on: ubuntu-latest
18-
19-
steps:
20-
- name: Checkout repo
21-
uses: actions/checkout@v3
22-
23-
- name: Set up Node.js
24-
uses: actions/setup-node@v3
25-
with:
26-
node-version: '18'
27-
28-
- name: Install Redoc CLI
29-
run: npm install -g redoc-cli
30-
31-
- name: Generate HTML docs with Redoc
32-
run: |
33-
mkdir -p redoc-static
34-
redoc-cli bundle openapi.yaml -o redoc-static/index.html
35-
36-
- name: Push to docs-api branch
37-
run: |
38-
git config --global user.name "github-actions[bot]"
39-
git config --global user.email "github-actions[bot]@users.noreply.github.com"
40-
41-
git fetch origin
42-
git checkout --orphan docs-api
43-
44-
git rm -rf . > /dev/null 2>&1 || true
45-
cp -r redoc-static/* .
46-
touch .nojekyll
47-
48-
git add .
49-
git commit -m "Update API docs"
50-
git push -f origin docs-api
5112

5213
trigger-wiki:
5314
runs-on: ubuntu-latest
54-
needs: build-docs
5515
steps:
5616
- name: Trigger repository_dispatch in OPP-wiki
5717
uses: peter-evans/repository-dispatch@v3

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Open Park Project Common
2-
This repository contains the common code for the Open Park Project. In particular, it contains the API definition and the class diagram for the Open Park Project.
3-
4-
## Requirements and architecture
5-
Requirements are specified in the `requirements.md` file.
6-
The class and context diagrams are created using the PlantUML language.
2+
This repository contains the common code for the Open Park Project.
73

84
## API Definition
95
The API definition is written in OpenAPI 3.1.0. The API definition is located in the `openapi.yaml` file.

class-diagram.puml

Lines changed: 0 additions & 66 deletions
This file was deleted.

context-diagram.puml

Lines changed: 0 additions & 18 deletions
This file was deleted.

requirements.md

Lines changed: 0 additions & 61 deletions
This file was deleted.

0 commit comments

Comments
 (0)