Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 1 addition & 9 deletions .github/workflows/build-matrix.org.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
workflow_dispatch:

jobs:
# Fetch the latest spec build, and apply styling to it.
# Apply styling to the spec documents.
# This step also sets up the OpenAPI UI.
build-spec:
name: "📖 Spec"
Expand All @@ -18,14 +18,6 @@ jobs:
uses: actions/checkout@v2
with:
submodules: 'recursive'
- name: "📥 matrix-doc OpenAPI artifact download"
uses: dawidd6/action-download-artifact@6f8f427fb41886a66b82ea11a5a15d1454c79415
with:
workflow: main.yml
workflow_conclusion: success
repo: ${{ github.repository_owner }}/matrix-doc
branch: main
name: openapi-artifact
- name: "📖 Update docs"
run: |
python3 -m venv env
Expand Down
67 changes: 0 additions & 67 deletions scripts/fetch-buildkite-artifact

This file was deleted.

29 changes: 7 additions & 22 deletions scripts/update_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,13 @@

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

SITE_BASE="$(pwd)"

if ! [ -z ${BUILDKITE_ACCESS_TOKEN+x} ]; then
# grab and unpack the latest matrix-docs build from buildkite
rm -rf assets.tar.gz assets
scripts/fetch-buildkite-artifact matrix-dot-org matrix-doc assets.tar.gz
fi

# otherwise, assume the latest build was fetched by Github Actions.
tar -xzf assets.tar.gz

# Set up foundations for RapiDoc API playground
rm -fr unstyled_docs/api/client-server
mkdir -p unstyled_docs/api/client-server/json
ln -s ../../../spec/client_server/latest.json unstyled_docs/api/client-server/json/api-docs.json

# and the unstable spec docs, but not:
# * the spec index (because we want to keep the git version, which points to a specific c-s version), or
# * the appendices, as we've frozen the old docs now and are not updating them until everything is moved over
# to the new spec redesign
rm -f assets/spec/index.html
rm -f assets/spec/appendices.html
cp -ar assets/spec unstyled_docs
Comment thread
turt2live marked this conversation as resolved.

# copy the unstyled docs and add the jekyll styling
rm -rf content/docs
cp -r unstyled_docs content/docs
Expand Down
48 changes: 0 additions & 48 deletions scripts/update_docs_local.sh

This file was deleted.