Browse Source

doc -> docs as Github needs a specific name

pull/1799/head
Gabe Kangas 3 years ago
parent
commit
d3aa3f87af
No known key found for this signature in database
GPG Key ID: 9A56337728BC81EA
  1. 2
      .gitattributes
  2. 4
      .github/workflows/generate-api-documentation.yaml
  3. 0
      docs/SECURITY.md
  4. 0
      docs/api/index.html
  5. 0
      docs/dependencies.md

2
.gitattributes vendored

@ -10,7 +10,7 @@ webroot/js/web_modules/videojs/* linguist-vendored @@ -10,7 +10,7 @@ webroot/js/web_modules/videojs/* linguist-vendored
webroot/js/web_modules/micromodal/dist/* linguist-vendored
static/* linguist-vendored
static/admin/* linguist-vendored
doc/api/* linguist-documentation
docs/api/* linguist-documentation
static/* linguist-vendored
static/admin/* linguist-vendored
static/admin/logs/* linguist-vendored

4
.github/workflows/generate-api-documentation.yaml

@ -14,7 +14,7 @@ jobs: @@ -14,7 +14,7 @@ jobs:
- name: Run redoc on openapi.yaml
run: |
npx redoc-cli bundle openapi.yaml -o doc/api/index.html --options '{"hideHostname": true, "pathInMiddlePanel": true}'
npx redoc-cli bundle openapi.yaml -o docs/api/index.html --options '{"hideHostname": true, "pathInMiddlePanel": true}'
- name: Commit changes
uses: EndBug/add-and-commit@v5
@ -22,6 +22,6 @@ jobs: @@ -22,6 +22,6 @@ jobs:
author_name: Owncast
author_email: owncast@owncast.online
message: "Commit updated API documentation"
add: "doc/api/index.html"
add: "docs/api/index.html"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0
doc/SECURITY.md → docs/SECURITY.md

0
doc/api/index.html → docs/api/index.html

0
doc/dependencies.md → docs/dependencies.md

Loading…
Cancel
Save