Commit Graph

5441 Commits (e77c2e3e1083460b486f3cbe5d7461e3fcfb375f)
 

Author SHA1 Message Date
Andrew Morgan e77c2e3e10 Opt for serving new spec JS/CSS dependencies locally instead of downloading from CDNs (#3036)
This PR does two things:

* Updates the git submodule for the new spec hugo theme ([google/docsy](https://github.com/google/docsy)) to our fork ([matrix-org/docsy](https://github.com/matrix-org/docsy)) which has a couple changes to load JS from local sources instead of remote, as well as allowing sites to override the URL that font CSS files are loaded from. Note that my definition of "font CSS" files here as CSS files that contain settings and point to locations of where font files (`.woff2`) are located.
* Adds a script (and the files generated as a result of running that script) that can take a google fonts URL, download the fonts it points to and spit out those fonts as well as a font CSS file pointing to them for local distribution. We then use the resulting font CSS file in our project variables.

This brings the benefit of not serving files from a CDN which can track users across the web, as well as inadvertently pinning docsy to a specific commit. The downside is that we need to remember to update [matrix-org/docsy](https://github.com/matrix-org/docsy) when needed (and apply the patches on top, though they're quite small).
3 years ago
Andrew Morgan ecfd57c504 Set canonifyURLs to true (#3037)
This fixes absolute path links when we're hosting the site under a
different path other than /.
3 years ago
Travis Ralston b139312532 Merge pull request #2998 from matrix-org/anoa/room_version_7
MSC2998: Room Version 7
3 years ago
Andrew Morgan ee1f85ca8b Update prod build's baseURL to /unstable (#3035)
Since we're deploying to https://spec.matrix.org/unstable now. This only updates the `baseURL` for our buildkite build. The default is still `/` when doing a local build.
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
Andrew Morgan 6ffa13d480 Update legacy doc buildkite step with comments and latest versions (#3033) 3 years ago
Andrew Morgan 25605b65a3 Don't generate matrix assets on CircleCI (#3034)
We already do this in the buildkite pipeline, so doing so in CircleCI is just
duplicate work.
3 years ago
Travis Ralston 5d275ab79e Merge pull request #3024 from matrix-org/travis/gh-tmpl
Override issue templates from org
3 years ago
Travis Ralston 3cb3b52753 Merge pull request #3003 from wbamberg/block-sizes
More consistent widths
3 years ago
Travis Ralston 7da1ed51a3 Update idea.md 3 years ago
Travis Ralston 551c22247d Override issue templates from org
We don't need OS information for a bug report here.
3 years ago
wbamberg 54a4f689a0 Merge pull request #3002 from wbamberg/fix-h7-h8
Remove h7 and h8 headings
3 years ago
Will 88e81b9c82 More consistent widths 3 years ago
wbamberg 1bfc3de6d6 Merge pull request #2992 from wbamberg/support-changelogs
Support changelogs
3 years ago
wbamberg 94f6cd21e3 Clarify the current situation wrt key derivation algorithms
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
3 years ago
wbamberg f1711ff3e4 Merge pull request #3000 from wbamberg/add-proposals-tables
Support rendering of proposal tables
3 years ago
Will a974bdaf45 Remove h7 and h8 headings 3 years ago
wbamberg d5f975edaf Merge pull request #2999 from wbamberg/stop-scroll-overflow
Prevent sidebar scroll from overflowing
3 years ago
Will 25924a498c Fix tab/spaces mix 3 years ago
wbamberg e88a18ca5d Merge pull request #2988 from wbamberg/support-rendered-data
Support rendered data
3 years ago
Will 2371a7a804 Prevent sidebar scroll from overflowing 3 years ago
Will 643cdd19c8 Support rendering of proposal tables 3 years ago
wbamberg 07c66616ac Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
3 years ago
wbamberg 6fc1f52f2f Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
3 years ago
wbamberg 942f865f64 Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
3 years ago
Will a0316f6794 Update path to Swagger files 3 years ago
Will 3e03e7b17a A few small fixes in /data and /content 3 years ago
Will 9a179038cc Fix links to rendered APIs 3 years ago
Will 72ff5b92cb Update content to call the new template for event definitions 3 years ago
Will 52f5e73a39 Update content to call the new template for HTTP APIs 3 years ago
Will 1d629bae40 Add styles for rendered data 3 years ago
Will 5f45a897ef Add templates used to render data 3 years ago
Will 06983e1eb1 Remove RST comment, add bullets into list 3 years ago
Will 215b625d81 Replace csv table with GFM table 3 years ago
Will 873e8b30eb Fix links in data 3 years ago
Will 27f8867aa0 Change RST code formatting markup to Markdown 3 years ago
Will c7cf90abfa Remove RST alert directives, replace with simple Markdown formatting 3 years ago
Will 00c6a866e2 Move raw API and event schemas into /data directory
Historical note: this was originally a series of several commits, spread out
over several weeks. They have been squashed together to make `git annotate`
work properly.

The original commits were:
 * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory
 * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files
 * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one
 * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly
 * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too
 * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
3 years ago
wbamberg a26c352d78 Merge pull request #1 from matrix-org/anoa/support-rendered-data
Reinstate and fix schema validation files
3 years ago
Andrew Morgan 3c66e149f3 Move validator.js to scripts/ directory, update calls 3 years ago
Andrew Morgan 64231f079d Update checker scripts to work correctly from the scripts/ dir
check-swagger-sources also had a bug which caused it to fail while validating the directory
structure of /data/api. This was fixed by @KitsuneRal - thank you!
3 years ago
Andrew Morgan b8dafe86f4 Move and more aptly name check_examples.py scripts 3 years ago
Andrew Morgan 2acc0a697b Clarify prose 3 years ago
Travis Ralston fadee276d2 Alter to reserve v7 instead of declare v7 3 years ago
Andrew Morgan 97109d4268 Remove MSC2175, MSC2174 due to lack of implementation 3 years ago
Will ee87cf2b63
Undo support for patch versions; use an opaque version string 3 years ago
Andrew Morgan 336e5a2c7a
v6 -> v7
Co-authored-by: Travis Ralston <travpc@gmail.com>
3 years ago
Andrew Morgan 1f07f0dc9a MSC2998 3 years ago
Andrew Morgan 3735def108 Define room version 7 3 years ago
Will 108b323e10
Current version should still point to the old spec 3 years ago