Richard van der Hoff
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
Stas Rudakou
b6c41727c5
Add PyYAML to scripts/README.md
...
PyYAML is a 3rd-party package used by `gendoc.py`.
9 years ago
Richard van der Hoff
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
Richard van der Hoff
f46a2a7f2b
Include the basePath in the path in swagger output
...
This fixes both SPEC-393, and ORG-52.
9 years ago
Richard van der Hoff
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
Richard van der Hoff
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
Richard van der Hoff
a8eed29e9f
gendoc: Allow multiple targets
9 years ago
Richard van der Hoff
7138205f31
Update README.md
...
escape angle-bracket to stop it getting lost in markdown
9 years ago
Richard van der Hoff
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
Richard van der Hoff
23c4ffbc1b
Add securityDefintions to generated swagger JSON
...
Also factor out to a common file
9 years ago
Richard van der Hoff
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
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
Richard van der Hoff
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
Daniel Wagner-Hall
072d285153
speculator: Allow access token to be specified
9 years ago
Richard van der Hoff
1f6c4d5bb2
Speed up gendoc.py by only running build.py once
9 years ago
Daniel Wagner-Hall
aaeaa1dd98
Detect major version in presence of patch release
9 years ago
Daniel Wagner-Hall
ad7874a730
Use site-relative stylesheet
9 years ago
Daniel Wagner-Hall
60127de1e3
Take list of files to edit as args
9 years ago
Daniel Wagner-Hall
a9b4f6fef0
Add missing _ to paths
9 years ago
Daniel Wagner-Hall
db5cad4711
Remove accidentally committed change
9 years ago
Daniel Wagner-Hall
99b8a066c8
Make dump-swagger work from all directories
9 years ago
Daniel Wagner-Hall
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
Richard van der Hoff
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
Richard van der Hoff
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
Matthew Hodgson
78e04d662e
add moi :(
9 years ago
Richard van der Hoff
1b7548d460
Make the speculator serve the spec from drafts branches.
9 years ago
Daniel Wagner-Hall
2f3a00fe34
Consistently spell homeserver as homeserver
9 years ago
Daniel Wagner-Hall
1ce3357927
continuserv: serve multiple paths
9 years ago
Daniel Wagner-Hall
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
Daniel Wagner-Hall
ebed3b60bd
Add trailing slashes to links
9 years ago
Daniel Wagner-Hall
a4668c1d8c
Fix typo
9 years ago
Daniel Wagner-Hall
c4eaf7458f
302 to spec/head/index.html rather than serving it on /spec/head
...
Otherwise relative links are broken
9 years ago
Daniel Wagner-Hall
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
Daniel Wagner-Hall
e401d3e262
Merge pull request #184 from matrix-org/daniel/splitspec
...
Split spec into page-per-section
9 years ago
Daniel Wagner-Hall
30ed918633
speculator: Allow spec viewing for multi-page spec
9 years ago
Daniel Wagner-Hall
e171acf01f
Split spec into page-per-section
9 years ago
Daniel Wagner-Hall
f0c99a6925
Generate API docs from swagger
9 years ago
Richard van der Hoff
2aa4773cc1
Make the speculator serve up errors as plain text
...
... so that they are legible.
9 years ago
Daniel Wagner-Hall
ec31c0f518
speculator: allow styling like matrix.org
9 years ago
Daniel Wagner-Hall
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
Daniel Wagner-Hall
c432396079
Add comment
9 years ago
Daniel Wagner-Hall
866fa58276
Rename
9 years ago
Daniel Wagner-Hall
e045f28b44
Pull out constant for permissions
...
Also, drop permissions from 0755 to 0700
9 years ago
Oddvar Lovaas
24356d864e
Merge pull request #176 from matrix-org/daniel/gendoc
...
Tweaks to spec generation for matrix.org
9 years ago
Daniel Wagner-Hall
4ac85997f5
Fix check
9 years ago
Daniel Wagner-Hall
da93317a78
Take dir not files as args
9 years ago
Daniel Wagner-Hall
ca3a9e3562
exec gendoc outside of script
9 years ago
Daniel Wagner-Hall
e041033048
Rename file
9 years ago
Daniel Wagner-Hall
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
Daniel Wagner-Hall
6f1d00097b
Only bother trying to fetch if we need to
9 years ago