Merge pull request #79 from armatronic/task-develop/SA-14762

Remove old docs completely [SA-14762]

Author: jleckie

.gitattributes

@@ -14,7 +14,6 @@ on:
     paths-ignore:
       - docs/builds/*
       - docs/builds.json
-      - docs/dist.yaml
 jobs:
   build:
     if: github.repository == 'alaress/schoolbox-api-docs'
@@ -33,7 +32,7 @@ jobs:
           git config --global user.name "github-actions[bot]"
           git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
 
-          # Copy all files (excl. builds/, builds.json, dist.yaml) into gh-pages repo
+          # Copy all files (excl. builds/, builds.json) into gh-pages repo
           mkdir .staging/
           cp -r ./* .staging/
 
@@ -44,7 +43,6 @@ jobs:
 
           # remove specs themselves
           rm -rf .staging/docs/builds/
-          rm -f .staging/docs/dist.yaml
           rm -f .staging/docs/builds.json
           
           # move files from base commit to gh-pages

.github/workflows/publish-design.yml

@@ -25,7 +25,7 @@ jobs:
           # Copy docs into gh-pages repo
           # Also copy openapi/ and .redocly.yaml (for building docs)
           mkdir .staging/
-          cp -r docs/ docs/ openapi/ .redocly.yaml .staging
+          cp -r docs/ openapi/ .redocly.yaml .staging
           git checkout -- .
           git checkout gh-pages
           cp -r .staging/* .
@@ -35,9 +35,9 @@ jobs:
           # do not set beta specs as the most recently selected
           npm ci
           npm run rebuild-builds-list
-          npm run build-new --build-version=${{ github.ref_name }}
+          npm run build --build-version=${{ github.ref_name }}
 
           # Commit and push
-          git add docs/builds docs/builds.json docs/dist.yaml
+          git add docs/builds docs/builds.json
           git commit --allow-empty -m "Publish spec for production release ${{ github.ref_name }}" .
           git push

.github/workflows/publish-spec-develop.yml

@@ -25,7 +25,7 @@ jobs:
           # Copy docs into gh-pages repo
           # Also copy openapi/ and .redocly.yaml (for building docs)
           mkdir .staging/
-          cp -r docs/ docs/ openapi/ .redocly.yaml .staging
+          cp -r docs/ openapi/ .redocly.yaml .staging
           git checkout -- .
           git checkout gh-pages
           cp -r .staging/* .
@@ -34,12 +34,9 @@ jobs:
           # Build the docs
           npm ci
           npm run rebuild-builds-list
-          npm run build-new --build-version=${{ github.ref_name }} --selected
-
-          # also do the old build (for now)
-          npm run build
+          npm run build --build-version=${{ github.ref_name }} --selected
 
           # Commit and push
-          git add docs/builds docs/builds.json docs/dist.yaml
+          git add docs/builds docs/builds.json
           git commit --allow-empty -m "Publish spec for production release ${{ github.ref_name }}" .
           git push

.github/workflows/publish-spec-master.yml

@@ -1,7 +1,5 @@
 # Dir for bundles
 dist
-# Filename for bundle
-./dist.yaml
 node_modules
 .idea
 .staging

.gitignore

@@ -44,13 +44,7 @@ steps provided below:
 
 #### Building API docs locally
 
-##### `npm run build`
-
-Bundles the current definition to `docs/dist.yaml`.
-
-(This is required for backward compatibility with the old single-version docs.)
-
-##### `npm run build-new --build-version=$buildVersion [--selected]`
+##### `npm run build --build-version=$buildVersion [--selected]`
 Bundles the current definition to `docs/builds/$buildVersion.yaml`, and also
 creates a dropdown option for this build so that it may be selected.
 
@@ -67,15 +61,21 @@ Validates the definition.
 
 ### Updating the API
 
-When updating the API, do the following before creating a pull request:
-* run `npm run build`
-* commit the resultant changes to `docs/dist.yaml`
+Create a new release whose version number matches the Schoolbox version number
+you wish to create a release for.
+
+Releases may be created at https://github.com/alaress/schoolbox-api-docs/releases.
+
+#### Beta releases
+
+- include the beta number, e.g. 22.1.0-beta3
+- check the pre-release checkbox
+
+#### Stable releases
+
+- do not include the beta number, e.g. 22.1.0
+- leave the pre-release checkbox unchecked
 
-If building documentation for a new Schoolbox version:
-* run `npm run build-new` for the new version
-  * if the new version is not a beta: provide the `--selected` flag
-* commit the changes to the builds list file `docs/builds.json`
-* commit the new YAML file in `docs/builds`
 
 ### Configuration
 

README.md

@@ -8,8 +8,7 @@
   },
   "private": true,
   "scripts": {
-    "build": "redocly bundle -o docs/dist.yaml && ./scripts/applyVersion.js latest docs/dist.yaml",
-    "build-new": "redocly bundle -o docs/builds/${npm_config_build_version}.yaml && ./scripts/addBuild.js ${npm_config_build_version} ${npm_config_selected} && ./scripts/applyVersion.js ${npm_config_build_version} docs/builds/${npm_config_build_version}.yaml",
+    "build": "redocly bundle -o docs/builds/${npm_config_build_version}.yaml && ./scripts/addBuild.js ${npm_config_build_version} ${npm_config_selected} && ./scripts/applyVersion.js ${npm_config_build_version} docs/builds/${npm_config_build_version}.yaml",
     "rebuild-builds-list": "./scripts/rebuildBuildsList.js",
     "test": "redocly lint"
   }