diff options
author | Lars Wirzenius <liw@liw.fi> | 2023-06-03 18:52:03 +0300 |
---|---|---|
committer | Lars Wirzenius <liw@liw.fi> | 2023-06-03 18:52:03 +0300 |
commit | f61e147a74302e992e4d01a723fe48bd6141483a (patch) | |
tree | b0c83ad17c58cee84d771cd300c2e2ddd8a041e4 /examples | |
parent | b3f9948a720eae708f7575d9a05943b85f328e42 (diff) | |
download | subplot-f61e147a74302e992e4d01a723fe48bd6141483a.tar.gz |
fix: change examples to use .subplot files
This means they actually work, oops. Fix markup problem in echo.md.
This change should mean that the rendered HTML for the example
subplots gets published on doc.subplot.tech.
Sponsored-by: author
Diffstat (limited to 'examples')
-rw-r--r-- | examples/echo/echo.md | 11 | ||||
-rw-r--r-- | examples/echo/echo.subplot | 10 | ||||
-rw-r--r-- | examples/muck/muck.md | 36 | ||||
-rw-r--r-- | examples/muck/muck.subplot | 12 | ||||
-rw-r--r-- | examples/website/website.md | 9 | ||||
-rw-r--r-- | examples/website/website.subplot | 10 |
6 files changed, 43 insertions, 45 deletions
diff --git a/examples/echo/echo.md b/examples/echo/echo.md index 495a102..8849b4b 100644 --- a/examples/echo/echo.md +++ b/examples/echo/echo.md @@ -1,14 +1,3 @@ ---- -title: "**echo**(1) acceptance tests" -author: The Subplot project -bindings: [echo.yaml] -impls: - bash: [echo.sh] -... - -FIXME: This needs to move back into YAML: bibliography: [echo.bib] - - Introduction ============================================================================= diff --git a/examples/echo/echo.subplot b/examples/echo/echo.subplot new file mode 100644 index 0000000..e8ae606 --- /dev/null +++ b/examples/echo/echo.subplot @@ -0,0 +1,10 @@ +title: "**echo**(1) acceptance tests" +authors: + - The Subplot project +markdowns: + - echo.md +bindings: + - echo.yaml +impls: + bash: + - echo.sh diff --git a/examples/muck/muck.md b/examples/muck/muck.md index b074424..0a28020 100644 --- a/examples/muck/muck.md +++ b/examples/muck/muck.md @@ -1,12 +1,3 @@ ---- -title: Muck JSON storage server and API -author: Lars Wirzenius -date: work in progress -bindings: [muck.yaml] -impls: - python: [muck.py] -... - Introduction ============================================================================= @@ -95,24 +86,19 @@ This chapter lists high level requirements for Muck. Each requirement here is given a unique mnemonic id for easier reference in discussions. -**SimpleOps** - -: Muck must be simple to install and operate. Installation should be - installing a .deb package, configuration by setting the public key - for token signing of the authentication server. - -**Fast** - -: Muck must be fast. The speed requirement is that Muck must be able - to handle at least 100 concurrent clients, creating 1000 objects - each, and then retrieving each object, and then deleting each - object, and all of this must happen in no more than ten minutes - (600 seconds). Muck and the clients should run on different - virtual machines. +**SimpleOps** --- Muck must be simple to install and operate. + Installation should be installing a .deb package, configuration by + setting the public key for token signing of the authentication + server. -**Secure** +**Fast** --- Muck must be fast. The speed requirement is that Muck + must be able to handle at least 100 concurrent clients, creating + 1000 objects each, and then retrieving each object, and then + deleting each object, and all of this must happen in no more than + ten minutes (600 seconds). Muck and the clients should run on + different virtual machines. -: Muck must allow access only by an authenticated client +**Secure** --- Muck must allow access only by an authenticated client representing a data subject, and must only allow that client to access objects owned by the data subject, unless the client has super privileges. The data subject specifies, via the access diff --git a/examples/muck/muck.subplot b/examples/muck/muck.subplot new file mode 100644 index 0000000..f6feb2a --- /dev/null +++ b/examples/muck/muck.subplot @@ -0,0 +1,12 @@ +--- +title: Muck JSON storage server and API +authors: + - Lars Wirzenius +date: work in progress +markdowns: + - muck.md +bindings: + - muck.yaml +impls: + python: + - muck.py diff --git a/examples/website/website.md b/examples/website/website.md index dab4d4f..b72862d 100644 --- a/examples/website/website.md +++ b/examples/website/website.md @@ -173,12 +173,3 @@ achieve this, you should make the following changes: [website.md]: https://gitlab.com/subplot/subplot/-/tree/main/examples/website/website.md [website.yaml]: https://gitlab.com/subplot/subplot/-/tree/main/examples/website/website.yaml [website.py]: https://gitlab.com/subplot/subplot/-/tree/main/examples/website/website.py - - ---- -title: Subplot website tutorial -author: The Subplot project -bindings: [website.yaml] -impls: - python: [website.py] -... diff --git a/examples/website/website.subplot b/examples/website/website.subplot new file mode 100644 index 0000000..a39d4e3 --- /dev/null +++ b/examples/website/website.subplot @@ -0,0 +1,10 @@ +title: Subplot website tutorial +authors: + - The Subplot project +markdowns: + - website.md +bindings: + - website.yaml +impls: + python: + - website.py |