Skip to content

Commit d4f7922

Browse files
Merge pull request #281 from terminusdb/doc_parsing
Doc parsing
2 parents 60c4e07 + b2b762f commit d4f7922

30 files changed

+442
-16495
lines changed

.github/workflows/ci.yml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,6 @@ jobs:
4242
npm run test:integration
4343
- name: Lint
4444
run: npm run lint:check
45-
- name: Check for changes to docs
46-
run: npm run mkdocs
47-
- name: Auto commit docs changes if any
48-
uses: stefanzweifel/git-auto-commit-action@v4
49-
with:
50-
commit_message: Apply docs changes
51-
file_pattern: docs/api/*.md
5245
- name: Genrate test coverage report
5346
run: npm run coveralls-after
5447
- name: Update coveralls

.github/workflows/docs.yml

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,23 @@
1-
name: Create PR on Docs repo
1+
name: Upload code docs to TerminusCMS
22
on:
33
push:
4-
paths:
5-
- 'docs/api/**'
6-
branches:
7-
- main
4+
tags:
5+
- v*
86

97
jobs:
108
pull-request:
119
runs-on: ubuntu-latest
1210
steps:
1311
- name: Checkout
14-
uses: actions/checkout@v2
15-
- name: Set BRANCH_NAME
16-
run: echo "BRANCH_NAME=JS-Reference-Updates-$(date +%s)" >> $GITHUB_ENV
17-
- name: Create pull request in terminusdb/terminusdb-docs
18-
uses: paygoc6/action-pull-request-another-repo@v1.0.1
19-
env:
20-
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
21-
with:
22-
source_folder: 'docs/api/.'
23-
destination_repo: 'terminusdb/terminusdb-docs'
24-
destination_folder: 'guides/reference-guides/javascript-client-reference'
25-
destination_base_branch: 'main'
26-
destination_head_branch: ${{ env.BRANCH_NAME }}
27-
user_email: 'neel@terminusdb.com'
28-
user_name: 'Neelterminusdb'
29-
pull_request_reviewers: 'mark-terminusdb'
12+
uses: actions/checkout@v3
13+
- name: Clone JSDoc template
14+
run: git clone https://github.com/terminusdb-labs/jsdoc-terminusdb-template.git
15+
- name: Run NPM Install
16+
run: npm i
17+
- name: Run JSDoc
18+
run: npx jsdoc --template ./jsdoc-terminusdb-template --recurse ./lib/ > docs.json || true
19+
- name: Upload to TerminusCMS
20+
run: |
21+
curl -H 'Authorization: Token ${{ secrets.TERMINUSCMS_TOKEN}}' \
22+
-H 'Content-Type: application/json' \
23+
'${{ secrets.TERMINUSCMS_URL}}' -d @./docs.json

docs/README.md

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

0 commit comments

Comments
 (0)