f1cc26dfd7
sort output by Created date per-table
7 years ago
b8f38b21a7
update introductory text
7 years ago
e87f1f2619
include PRs in tables
7 years ago
3b4e56c4e0
handle dd/mm/yyyy and yyyy-mm-dd dates in text
7 years ago
3b84de383c
cleanup and include all content
7 years ago
cbdd33a5f5
single authors and shepherds link correctly
7 years ago
73b7faddd4
handle multiple Google Docs
7 years ago
866b0b6348
I mostly play with ascii art
7 years ago
dc2b53318b
prettify ID column
7 years ago
a78f7b38e9
generator is now usable
7 years ago
c58dc59ffe
separate tables by label
7 years ago
1f7fbefd53
start using a table
7 years ago
e18aa30fd2
start generating new proposals page
7 years ago
f04b17f1c9
Fix path to fsnotify
...
Apparently this should be referred to as gopkg.in/fsnotify/fsnotify.v1. I'm not
sure what has changed to stop the old format working.
7 years ago
8e97ec8bad
make the speculator work for rick
7 years ago
9150ba0dce
Improve error output from failing to parse examples
7 years ago
a36bd1a6d2
Make build fail if gendoc fails
...
(cf https://github.com/matrix-org/matrix-doc/issues/1146 )
7 years ago
87d90ab58a
gendoc: improve title line matching
...
This makes it possible to include tables etc without the script trying to turn
them into titles.
7 years ago
1045bc721d
Document federation version endpoint
7 years ago
427e0bb83b
make jenkins and travis use a common script
7 years ago
202a265d85
Config for travis-ci
7 years ago
0cbf533625
Use petstore for continuserv swagger docs
...
Matrix.org's swagger browser is behind https, which means it can't read the
swagger from a continuserv on http. Use the petstore instead.
7 years ago
a38d4fc68e
Move templating into scripts dir
...
There's no real need for this to be at the top level.
7 years ago
e7772af5c3
Supporting-docs now in matrix.org repo.
7 years ago
cc6b16b63c
Generate the swagger for export
...
We may as well generate the unstable version of the C-S swagger.
7 years ago
d6f892f894
continuserv, speculator: update dump-swagger call
...
dump-swagger now expects -o before its output path
7 years ago
56c3e5a627
README.rst: Add notes on how to build the spec
7 years ago
834a3d78a8
Add a pip requirements file for the scripts
7 years ago
986c9d99a0
Improve arg parsing in dump-swagger
7 years ago
0dfff6b190
Simplify dump_swagger
...
We don't need most of the templating stuff. All we have to do is merge together
the swagger files, and resolve references.
7 years ago
2454598926
Speculator: include API docs links for branches
7 years ago
13d3293378
Fix version-extraction regexp
...
Fixes https://github.com/matrix-org/matrix-doc/issues/982
7 years ago
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
8a66b1a68b
Build the spec as part of the build
7 years ago
0af06291fe
Hardcode client major version r0
7 years ago
986e51cf35
Gendoc: allow overriding the dest dir
7 years ago
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
934dd4754c
swagger-http-server: fix port param
...
it needs to be an int, not a list
8 years ago
2ec43a5948
Add continuserv index
...
Oops, forgot this when adding support for the API docs to continuserv in
bfb65d8
8 years ago
d41438605d
Use matrix.org for swagger UI
...
In the swagger UI, default to matrix.org rather than localhost, to make the UI
more useful.
8 years ago
bfb65d8ceb
Serve the API docs with continuserv
8 years ago
1320a86cbe
Serve the api docs from the speculator
...
There are a few parts to this:
* when we generate the spec for a particular git sha, also run the script which
turns our yaml api descriptions into a swagger json file.
* tweak serveSpec to add another header when serving the generated json.
* add a link to the generated index which will (via js hackery) redirect to our
hosted swagger UI at http://matrix.org/docs/api/client-server , with a "url"
query-param pointing at the generated json.
Also, factor makeTempDir out of gitClone, so that we can give clearer log lines.
8 years ago
459f4b953d
swagger-http-server: add a --port argument
8 years ago
1ea836bb1b
Remove howtos from build script
8 years ago
33d80408e0
Add a nix-shell environment suitable for building
...
This enables easy execution of scripts/*.py by Nix users.
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
49cd65dd58
Add a license to the spec
...
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
9 years ago
b6c41727c5
Add PyYAML to scripts/README.md
...
PyYAML is a 3rd-party package used by `gendoc.py`.
9 years ago
8b61dab1c6
gendoc.py: add --list_targets arg
...
I want to be able to run all of the targets except one from matrix-doc, so make
a way to list the targets.
9 years ago
f46a2a7f2b
Include the basePath in the path in swagger output
...
This fixes both SPEC-393, and ORG-52.
9 years ago
8aa0f64665
Update the speculator to understand spec subdirs
...
Fix the speculator so that it doesn't blow up when it finds subdirs in the gen
directory.
(It doesn't handle the html diff very well in the case that the subdirs don't
match, but it's hard to do much about that)
9 years ago
01f8173c84
Put each bit of spec in its own directory
...
I want to change the URLs for the spec sections on the website from
<version>/<section>.html to <section>/<version>.html, to better reflect how we
do the versioning.
This puts each bit of spec in its own directory, updates the index to point to
the right place, and fixes continuserv to deal with directories as well as
files.
This will probably require fixes to the speculator too, but I'll have to come
back to that.
9 years ago
a8eed29e9f
gendoc: Allow multiple targets
9 years ago
7138205f31
Update README.md
...
escape angle-bracket to stop it getting lost in markdown
9 years ago
0546f0917d
Replace hacky shell to do matrix styling with hacky perl
...
Since the shell just wrapped three invocations of perl, we might as well do
it all in perl.
9 years ago
23c4ffbc1b
Add securityDefintions to generated swagger JSON
...
Also factor out to a common file
9 years ago
60f36bf868
Script to serve the generated swagger JSON
...
We need custom CORS headers to serve the swagger JSON, so add a script to do it
9 years ago
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
d6c1d1343b
Continuserv: Reduce number of watches
...
rather than trying to watch half the filesystem, be a bit more conservative in
what we put watches on. This means that we don't end up dying with "No space on
device" (thanks for that, Linux.)
9 years ago
072d285153
speculator: Allow access token to be specified
9 years ago
1f6c4d5bb2
Speed up gendoc.py by only running build.py once
9 years ago
aaeaa1dd98
Detect major version in presence of patch release
9 years ago
ad7874a730
Use site-relative stylesheet
9 years ago
60127de1e3
Take list of files to edit as args
9 years ago
a9b4f6fef0
Add missing _ to paths
9 years ago
db5cad4711
Remove accidentally committed change
9 years ago
99b8a066c8
Make dump-swagger work from all directories
9 years ago
1f5b6271f2
Generate swagger-ui output for client-server API
...
Depends on:
https://github.com/matrix-org/matrix-doc/pull/212
https://github.com/matrix-org/matrix-doc/pull/208
https://github.com/matrix-org/matrix-doc/pull/207
for the actual rendered output to not throw javascript errors at runtime.
9 years ago
d1d3d27e2f
Merge pull request #216 from matrix-org/rav/fix_speculator_redirects
...
Add a host and scheme to Location headers in redirects
9 years ago
f31a053995
Add a host and scheme to Location headers in redirects
...
Our apache reverse-proxy can't correctly rewrite relative Location headers, so
add the Host from the request into the Location.
9 years ago
78e04d662e
add moi :(
9 years ago
1b7548d460
Make the speculator serve the spec from drafts branches.
9 years ago
2f3a00fe34
Consistently spell homeserver as homeserver
9 years ago
1ce3357927
continuserv: serve multiple paths
9 years ago
97fd1fdd62
Embed client and server release numbers
...
Note that this also removes the changelog - I'm going to re-add the
changelog differently soon.
9 years ago
ebed3b60bd
Add trailing slashes to links
9 years ago
a4668c1d8c
Fix typo
9 years ago
c4eaf7458f
302 to spec/head/index.html rather than serving it on /spec/head
...
Otherwise relative links are broken
9 years ago
6c66bfc755
Flatten out v1 and v2_alpha directories
...
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
9 years ago
e401d3e262
Merge pull request #184 from matrix-org/daniel/splitspec
...
Split spec into page-per-section
9 years ago
30ed918633
speculator: Allow spec viewing for multi-page spec
9 years ago
e171acf01f
Split spec into page-per-section
9 years ago
f0c99a6925
Generate API docs from swagger
9 years ago
2aa4773cc1
Make the speculator serve up errors as plain text
...
... so that they are legible.
9 years ago
ec31c0f518
speculator: allow styling like matrix.org
9 years ago
cc4869e68a
Merge pull request #174 from matrix-org/daniel/speculatorhardening
...
Several improvements to speculator to prepare it for actually being used by the masses, not just us devs
9 years ago
c432396079
Add comment
9 years ago
866fa58276
Rename
9 years ago
e045f28b44
Pull out constant for permissions
...
Also, drop permissions from 0755 to 0700
9 years ago
24356d864e
Merge pull request #176 from matrix-org/daniel/gendoc
...
Tweaks to spec generation for matrix.org
9 years ago
4ac85997f5
Fix check
9 years ago
da93317a78
Take dir not files as args
9 years ago
ca3a9e3562
exec gendoc outside of script
9 years ago
e041033048
Rename file
9 years ago
8586744771
Add anchors to spec
...
This is currently done by a script on the prod serving machine.
We might as well keep the matrix.org spec and dev spec as similar as
possible.
9 years ago
6f1d00097b
Only bother trying to fetch if we need to
9 years ago
8872e17f93
Fall back to last known HEAD sha if fetch fails
9 years ago
dd53847211
Include command stderr in error text
9 years ago
9ad64b02d1
speculator: guard against concurrent git commands
9 years ago
0f0359d9c1
speculator: Nessle up some more if statements
9 years ago
740cc66a7c
speculator: Fetch before deciding head is fresh
9 years ago
Ben Parsons