Commit Graph

5436 Commits (d3adafb984f8cdbcc42519462938d2df495aca6c)
 

Author SHA1 Message Date
Andrew Morgan d3adafb984
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".
5 years ago
Andrew Morgan 68c81079c2
Update legacy doc buildkite step with comments and latest versions (#3033) 5 years ago
Andrew Morgan dc3c325070
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.
5 years ago
Travis Ralston c2c6073072
Merge pull request #3024 from matrix-org/travis/gh-tmpl
Override issue templates from org
5 years ago
Travis Ralston 4d73c89eb7
Update idea.md 5 years ago
Travis Ralston 2e59a80049 Override issue templates from org
We don't need OS information for a bug report here.
5 years ago
Travis Ralston e30a717383
Merge pull request #3003 from wbamberg/block-sizes
More consistent widths
5 years ago
wbamberg 7d42dac2ad
Merge pull request #3002 from wbamberg/fix-h7-h8
Remove h7 and h8 headings
5 years ago
wbamberg 74bf89f2ce
Merge pull request #2992 from wbamberg/support-changelogs
Support changelogs
5 years ago
wbamberg 04018206ac
Clarify the current situation wrt key derivation algorithms
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
5 years ago
Will 0b5e9e6d23
More consistent widths 5 years ago
Will e5658d71c1
Remove h7 and h8 headings 5 years ago
wbamberg de2aa0c3aa
Merge pull request #3000 from wbamberg/add-proposals-tables
Support rendering of proposal tables
5 years ago
Will e8d3f09836
Fix tab/spaces mix 5 years ago
wbamberg 0a65f9a18f
Merge pull request #2999 from wbamberg/stop-scroll-overflow
Prevent sidebar scroll from overflowing
5 years ago
Will ee87cf2b63
Undo support for patch versions; use an opaque version string 5 years ago
Will 1be92ad64f
Support rendering of proposal tables 5 years ago
Will 17e634d78a
Prevent sidebar scroll from overflowing 5 years ago
wbamberg 6914402338
Merge pull request #2988 from wbamberg/support-rendered-data
Support rendered data
5 years ago
Will 108b323e10
Current version should still point to the old spec 5 years ago
Will 301c7b2f07
Restore docs describing OpenAPI extensions that we use 5 years ago
wbamberg 64c340d032
Merge pull request #1 from matrix-org/anoa/support-rendered-data
Reinstate and fix schema validation files
5 years ago
wbamberg e79a8d4e0d
Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
5 years ago
wbamberg fd17b647f4
Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
5 years ago
wbamberg 342c7713e5
Fix typo in comment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
5 years ago
Andrew Morgan 166d6adcab Move validator.js to scripts/ directory, update calls 5 years ago
Andrew Morgan e15b2cbfc7 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!
5 years ago
Andrew Morgan 26a2e4a873 Move and more aptly name check_examples.py scripts 5 years ago
Will b79d489f91
Fix comment in changelog template 5 years ago
Will 9f3df1950f
Add changelog page and templates 5 years ago
Will 415199bd3d
Use Markdown in changelog descriptions 5 years ago
Will abdcf8d41c
Update path to Swagger files 5 years ago
Travis Ralston 315cf67f6b
Merge pull request #2366 from uhoreg/key_verification_accept
MSC2366: Key verification flow additions: m.key.verification.ready and m.key.verification.done
5 years ago
Will a133921893
A few small fixes in /data and /content 5 years ago
Will f0a7ba7acf
Fix links to rendered APIs 5 years ago
Will 83f71104f3
Update content to call the new template for event definitions 5 years ago
Will 1a21598c5c
Update content to call the new template for HTTP APIs 5 years ago
Will 6242783041
Add styles for rendered data 5 years ago
Will 6c5899a09e
Add templates used to render data 5 years ago
Will 0965bf1592
Remove RST comment, add bullets into list 5 years ago
Will 377fa396b2
Replace csv table with GFM table 5 years ago
Will 3ce9f5f47d
Merge remote-tracking branch 'upstream/master' into support-rendered-data
* upstream/master: (24 commits)
  Use italics instead of code formatting
  Formatting fixes for the authentication section
  Fix mangling of sub/superscript in e2e module
  Replace sas-emojis template
  Remove changelog sections
  Remove {{apis}} template
  Update proposals document
  Add example that went missing
  Add content for rooms list page
  Use GFM table syntax instead of raw HTML
  Extend blockquote style
  Fix broken Markdown lists
  Fix heading levels
  Fix internal links
  Support alerts (notes, warnings, rationales)
  Add syntax highlighting
  Fix ASCII diagrams
  Remove 'unstable' warning
  Add support for modules
  Remove 'Table of Contents'
  ...
5 years ago
wbamberg 7fed40ad04
Merge pull request #2980 from wbamberg/all-spec-pages
Migrate all spec pages
5 years ago
Will 68370677ef
Use italics instead of code formatting 5 years ago
Will c12c57f389
Fix links in data 5 years ago
Will 2c74daefa3
Change RST code formatting markup to Markdown 5 years ago
Will 6f1cfedad0
Remove RST alert directives, replace with simple Markdown formatting 5 years ago
Will 21060109e8
Remove symlink to event-schemas, and update openAPI schema paths accordingly 5 years ago
Will 1092d4ca14
Add data-compatiuble extension (.yaml) to all data files that currently omit one 5 years ago
Will aae22f477d
Remove non-data files 5 years ago