Skip to content

Commit c2fd0cc

Browse files
authored
Stop trying to publish the unstable spec (#1092)
This hasn't really worked properly since matrix-doc was redesigned to use hugo, but we still had a few vestiges of the old code hanging around. In particular, there is no need to fetch the matrix-doc assets, and no need to attempt to style them.
1 parent 4b4a8e6 commit c2fd0cc

File tree

4 files changed

+8
-146
lines changed

4 files changed

+8
-146
lines changed

.github/workflows/build-matrix.org.yml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
workflow_dispatch:
88

99
jobs:
10-
# Fetch the latest spec build, and apply styling to it.
10+
# Apply styling to the spec documents.
1111
# This step also sets up the OpenAPI UI.
1212
build-spec:
1313
name: "📖 Spec"
@@ -18,14 +18,6 @@ jobs:
1818
uses: actions/checkout@v2
1919
with:
2020
submodules: 'recursive'
21-
- name: "📥 matrix-doc OpenAPI artifact download"
22-
uses: dawidd6/action-download-artifact@6f8f427fb41886a66b82ea11a5a15d1454c79415
23-
with:
24-
workflow: main.yml
25-
workflow_conclusion: success
26-
repo: ${{ github.repository_owner }}/matrix-doc
27-
branch: main
28-
name: openapi-artifact
2921
- name: "📖 Update docs"
3022
run: |
3123
python3 -m venv env

scripts/fetch-buildkite-artifact

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

scripts/update_docs.sh

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@
22

33
# update_docs.sh: regenerates the autogenerated files on the matrix.org site.
44
# At present this includes:
5-
# * the spec intro and appendices
6-
# * the guides and howtos
7-
# * 'Unstable' versions of the spec docs
5+
#
6+
# * the spec intro and appendices, at https://matrix.org/docs/spec/ and
7+
# https://matrix.org/docs/spec/appendices (though note that it is planned
8+
# to move these to https://spec.matrix.org)
9+
#
10+
# * the guides and howtos at https://matrix.org/docs/develop/
11+
#
812
# * the RapiDoc UI for the API
913
#
1014
# Note that the historical versions of the CS spec and swagger, and the spec
@@ -19,30 +23,11 @@ fi
1923
SELF="${SELF/\/.\///}"
2024
cd "$(dirname "$(dirname "${SELF}")")"
2125

22-
SITE_BASE="$(pwd)"
23-
24-
if ! [ -z ${BUILDKITE_ACCESS_TOKEN+x} ]; then
25-
# grab and unpack the latest matrix-docs build from buildkite
26-
rm -rf assets.tar.gz assets
27-
scripts/fetch-buildkite-artifact matrix-dot-org matrix-doc assets.tar.gz
28-
fi
29-
30-
# otherwise, assume the latest build was fetched by Github Actions.
31-
tar -xzf assets.tar.gz
32-
3326
# Set up foundations for RapiDoc API playground
3427
rm -fr unstyled_docs/api/client-server
3528
mkdir -p unstyled_docs/api/client-server/json
3629
ln -s ../../../spec/client_server/latest.json unstyled_docs/api/client-server/json/api-docs.json
3730

38-
# and the unstable spec docs, but not:
39-
# * the spec index (because we want to keep the git version, which points to a specific c-s version), or
40-
# * the appendices, as we've frozen the old docs now and are not updating them until everything is moved over
41-
# to the new spec redesign
42-
rm -f assets/spec/index.html
43-
rm -f assets/spec/appendices.html
44-
cp -ar assets/spec unstyled_docs
45-
4631
# copy the unstyled docs and add the jekyll styling
4732
rm -rf content/docs
4833
cp -r unstyled_docs content/docs

scripts/update_docs_local.sh

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

0 commit comments

Comments
 (0)