|
2 | 2 |
|
3 | 3 | # update_docs.sh: regenerates the autogenerated files on the matrix.org site. |
4 | 4 | # 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 | +# |
8 | 12 | # * the RapiDoc UI for the API |
9 | 13 | # |
10 | 14 | # Note that the historical versions of the CS spec and swagger, and the spec |
|
19 | 23 | SELF="${SELF/\/.\///}" |
20 | 24 | cd "$(dirname "$(dirname "${SELF}")")" |
21 | 25 |
|
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 | | - |
33 | 26 | # Set up foundations for RapiDoc API playground |
34 | 27 | rm -fr unstyled_docs/api/client-server |
35 | 28 | mkdir -p unstyled_docs/api/client-server/json |
36 | 29 | ln -s ../../../spec/client_server/latest.json unstyled_docs/api/client-server/json/api-docs.json |
37 | 30 |
|
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 | | - |
46 | 31 | # copy the unstyled docs and add the jekyll styling |
47 | 32 | rm -rf content/docs |
48 | 33 | cp -r unstyled_docs content/docs |
|
0 commit comments