From d3aa3f87af7801e6562f01698be2bd4866e32427 Mon Sep 17 00:00:00 2001 From: Gabe Kangas Date: Sat, 19 Mar 2022 12:02:34 -0700 Subject: [PATCH] doc -> docs as Github needs a specific name --- .gitattributes | 2 +- .github/workflows/generate-api-documentation.yaml | 4 ++-- {doc => docs}/SECURITY.md | 0 {doc => docs}/api/index.html | 0 {doc => docs}/dependencies.md | 0 5 files changed, 3 insertions(+), 3 deletions(-) rename {doc => docs}/SECURITY.md (100%) rename {doc => docs}/api/index.html (100%) rename {doc => docs}/dependencies.md (100%) diff --git a/.gitattributes b/.gitattributes index 0399c65bd..73a4b939a 100644 --- a/.gitattributes +++ b/.gitattributes @@ -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 diff --git a/.github/workflows/generate-api-documentation.yaml b/.github/workflows/generate-api-documentation.yaml index a1839eab0..d97b77e00 100644 --- a/.github/workflows/generate-api-documentation.yaml +++ b/.github/workflows/generate-api-documentation.yaml @@ -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: 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 }} diff --git a/doc/SECURITY.md b/docs/SECURITY.md similarity index 100% rename from doc/SECURITY.md rename to docs/SECURITY.md diff --git a/doc/api/index.html b/docs/api/index.html similarity index 100% rename from doc/api/index.html rename to docs/api/index.html diff --git a/doc/dependencies.md b/docs/dependencies.md similarity index 100% rename from doc/dependencies.md rename to docs/dependencies.md