aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2021-03-18 00:40:09 +0100
committerJonas Smedegaard <dr@jones.dk>2021-03-18 00:40:09 +0100
commite5a71a823051f4b0b64fb22ead32ba673b819d73 (patch)
tree800e9a6adaa60cff75c45eb918a5c97483152996
initial draft
-rw-r--r--README.md13
-rw-r--r--SETUP.md14
-rw-r--r--TODO.md80
-rw-r--r--USE.md19
4 files changed, 126 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b938bda
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Website editing _(website-edit)_
+
+This is a brief introduction to editing websites.
+
+One or more of the {{organisation}} websites can be edited live,
+with no technical skills required.
+
+These websites uses the [Micropub] Open Standard
+to enable simple page editing, creation, and removal.
+
+Only simple content editing is accessible this way.
+Changing structural and visual design is a separate task,
+requiring technical skills and different access rights.
diff --git a/SETUP.md b/SETUP.md
new file mode 100644
index 0000000..322fa80
--- /dev/null
+++ b/SETUP.md
@@ -0,0 +1,14 @@
+# Preparations for website editing
+
+You will need any [Micropub](https://indieweb.org/Micropub) client
+that supports adding and editing [article](https://indieweb.org/article) posts.
+
+
+## Recommended client
+
+[TODO]
+
+
+## Access rights
+
+[TODO]
diff --git a/TODO.md b/TODO.md
new file mode 100644
index 0000000..af19b49
--- /dev/null
+++ b/TODO.md
@@ -0,0 +1,80 @@
+# Pending tasks for website editing
+
+
+## Micropub server
+
+[Several servers](https://indieweb.org/Micropub/Servers) exist.
+
+We should first check if any existing implementation fits our needs:
+
+* Free Software
+* Sensible for self-hosting
+ * Reasonably security (excludes PHP code)
+ * Reasonably memory-efficient (excludes Java and Scala code)
+ * Reasonably decentral (excludes Go code)
+ * Reasonable to package (excludes Swift and Elixir code)
+* Content stored in git (SQL used only for caching if at all)
+* Content format is Markdown (preferably CommonMark)
+* must support [article](https://indieweb.org/article) posts
+* must support updating existing posts
+
+If (as expected) none of the existing server implementations fit out needs,
+we should either extend an existing backend or implement one from scratch.
+
+### Extend Ikiwiki
+
+### Extend/repurpose Web-UI scratchpad
+
+### Develop server from scratch
+
+
+## Micropub client
+
+[Several clients](https://indieweb.org/Micropub/Clients) exist.
+
+We should test and recommend the most sensible ones for our purpose.
+
+* Android
+ * [Indigenous](https://f-droid.org/en/packages/com.indieweb.indigenous/)
+
+If (unexpectedly) none of the existing client implementations fit out needs,
+we should either extend an existing frontend or implement one from scratch.
+
+### Extend/repurpose Web-UI editor
+
+### Extend/repurpose Web-UI scratchpad
+
+### Develop client from scratch
+
+
+## Explore alternatives
+
+If neither Micropub servers nor Micropub clients fit our needs,
+or if implementing either of them is too big a challenge,
+an alternative might be to skip Micropub
+and instead extend or repurpose an existing integrated service.
+
+### Extend web-UI editor Dillinger
+
+<https://dillinger.io/>
+
+Need [plugin](https://github.com/joemccann/dillinger#plugins)
+
+* Solid
+* Self-hosted git
+
+### Extend web-UI editor NetlifyCMS
+
+<https://www.netlifycms.org/>
+
+### Extend local GUI
+
+Maybe suggest local GUI editor(s)
+
+### Extend web-UI scratchpad
+
+Maybe suggest collaborative web-UI scratchpad(s)
+
+* <https://blankslate.io/>
+* <https://hackmd.io/>
+* <https://pad.riseup.net/>
diff --git a/USE.md b/USE.md
new file mode 100644
index 0000000..223031d
--- /dev/null
+++ b/USE.md
@@ -0,0 +1,19 @@
+# Edit a website
+
+Use your [Micropub](https://indieweb.org/Micropub) client
+to add articles or edit existing ones.
+
+
+## Add
+
+[TODO]
+
+
+## Replace
+
+[TODO]
+
+
+## Delete
+
+[TODO]