Commit Graph

33 Commits (c0babbfc13dd0ea29a9a00c7e24dfbec692795c6)

Author SHA1 Message Date
Richard van der Hoff 2a5e33a760
Revert "add node_modules (#3632)" (#3633)
This reverts commit cf73fb97bc.

this was a duplicate of an existing entry
3 years ago
Jonathan de Jong cf73fb97bc
add node_modules (#3632) 3 years ago
Andrew Morgan a8f7723fe5 Rename assets-hugo directory to assets (#3259)
Now that we've dropped the old build pipeline (and an assets directory does not exist in the repo any longer, we can rename the hugo version of the assets (assets-hugo) created during the build tools migration back to simply assets.
3 years ago
Travis Ralston 4734f40098 Add hugo build lock to gitignore 3 years ago
Travis Ralston e8674688e6
Release process: changelog generation and docs (#3446)
* Remove extra pyprojects and update changelog docs

* Add script for rendering the changelog

* Add docs for how to release the spec

* Move legacy changelogs out of the way
3 years ago
Richard van der Hoff 61ac438871
Remove the old templating system (#3445)
* Inline resolve_references in dump-swagger

Since this is the only bit of the old templating system we still use, let's
inline it.

OrederedLoader and OrderedDict are now redundant, because all dicts in Python
preserve insertion order.

* Remove the old templating system

We've now replaced the old templates with hugo, so we can get rid of this mess.
3 years ago
Travis Ralston 5be0df02c5
Start annotating which version of the spec added a thing (#3425)
* Introduce a new "added-in" template and use it on endpoints

* Use "added-in" on schema properties too

* Annotate sections of the spec with their added versions

* Demo of "added-in" on a room version (to be fleshed out)

* Use clearer versioning semantics

* Update and fix validator for Swagger custom properties

* Fix docs
3 years ago
Andrew Fargo 43a71c0092
Remove all references to speculator (#3430)
Signed-off-by: DCFargo <drew.fargo@gmail.com>
3 years ago
Travis Ralston 52cd88f070 Rewrite readme and update contributor docs
Incorporates https://github.com/matrix-org/matrix-doc/pull/3025/
3 years ago
Andrew Morgan a17023962c Update CircleCI and Buildkite configs to build the new spec (#3017)
This PR attempts to update the CI of matrix-doc to build [the new spec redesign](https://github.com/matrix-org/matrix-doc/issues/2906). It does so by additionally building the new spec in parallel to the old. The plan is to continue to host the old spec at https://matrix.org/docs/spec, while the new spec will be at https://spec.matrix.org. Eventually we will retire the old version of the spec, and have the old URL redirect to the new one.

In detail, this PR:
* Adds a new step to CircleCI to build the new spec with `hugo`. This step uses alpine, grabs some dependencies, and then builds the HTML.
  * We needed to hand some specific options to hugo for CircleCI in order to continue allowing CircleCI to host temporary builds of the spec after each CI run. This required changing some assumptions related to relative paths.
  * CircleCI's artifacts hosting is also quite limited. Specifically it will not automatically resolve `/some/path` to `/some/path/index.html`, which our hugo theme relied on. Fixes were implemented for this, but we may want to consider switching away from CircleCI artifacts as a host, and using something like [netlify](https://www.netlify.com/) instead.
* Modifies the existing Buildkite pipeline step to build both the new spec in a separate step. It additionally modifies the old spec to be built with alpine. (Separate out into another PR)
  * We'd like to separate out the deployment of matrix.org from the new spec. Therefore a new step, with a separate artifact build (`spec.tar.gz`). We will eventually remove the old step and the matrix.org build trigger.
* Modifies `pyproject.toml` to update the config of [giles](https://github.com/OpenAstronomy/baldrick/blob/master/baldrick/plugins/circleci_artifacts.py), which is what creates the "docs", "swagger" links in the CI steps for matrix-docs PRs.
  * A new step was added for the new spec. The old spec was renamed to "legacy".
3 years ago
Will 643cdd19c8 Support rendering of proposal tables 3 years ago
Will 9fd35dad78
Use a different directory for assets 4 years ago
Will 9547ba1314
Ignore node_modules 4 years ago
Will 55eae7b70b
Render a single page of the spec in Hugo 4 years ago
Patrick Cloke 420180a69d MSC: Remove query_auth federation endpoint. 5 years ago
Erik Johnston 1ea03da9b6 Add .vscode to .gitignore 6 years ago
Travis Ralston 9277e4c52d Add initial towncrier support 7 years ago
Travis Ralston f54d5a4039 Convert build scripts to python 3 7 years ago
Travis Ralston 864b6b6b3a Add build output to the .gitignore
This is more of a problem if the build fails for whatever reason.

Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Travis Ralston 714c922371 Update .gitignore
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Travis Ralston a1265a274b Add spec for m.room.pinned_events
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Richard van der Hoff b0ea6038c6 Move jekyll back out of matrix-doc again
Having the jekyll assets here is a mistake, because they need to be versioned
separately to the spec: we keep old versions of the spec, but they sometimes
need to be restyled to match the latest website.
7 years ago
Richard van der Hoff 9d2a93ad7b Run jekyll as part of the matrix-doc build
- this saves us having to run it manually on the web server.
7 years ago
Richard van der Hoff c39d797cce Dump-swagger: take output file name rather than output dir
Make the argument to dump-swagger.py be the name of the output file rather than
the output dir, and give it a sensible default.

Also, use the absolute path to the output file, so that the output path is
relative to the user's cwd rather than the templating dir.
9 years ago
Daniel Wagner-Hall f4f186baee Add _cs suffix to client-server http APIs
I'm about to add identity service APIs, so differentiating is good.
9 years ago
Daniel Wagner-Hall b247761465 .gitignore speculator 9 years ago
Daniel Wagner-Hall c4acee3bcb continuserv: Live serves updates to the spec 9 years ago
Daniel Wagner-Hall 267d2bd3de Add api/node_modules to .gitignore 9 years ago
Oddvar Lovaas 16ff77adf9 AS guide and index page added 9 years ago
Oddvar Lovaas b24582aead Introducing jekyll (jekyllrb.com) for docs 9 years ago
Kegan Dougal d6943dfbff Update .gitignore 10 years ago
Kegan Dougal 7563f1058b Make the templating system work(!) 10 years ago
Kegan Dougal df448df813 Redo gendoc script. 10 years ago