From 03b581743b38af31e847446c2eac064f4107208a Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Sat, 23 Apr 2022 14:52:03 +0200 Subject: improve SETUP; tidy links and FIXME hints --- README.md | 3 +++ SETUP.md | 46 +++++++++++++++++++++++++++++++++++++++++----- USE.md | 11 +++++++---- 3 files changed, 51 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 37b6bad..2eb4da3 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,9 @@ Only simple content editing is accessible this way. Changing structural and visual design is a separate task, requiring technical skills and different access rights. +[Micropub]: + "Micropub - open standard for simple web content editing" + ## Special strings diff --git a/SETUP.md b/SETUP.md index 322fa80..0b239d4 100644 --- a/SETUP.md +++ b/SETUP.md @@ -1,14 +1,50 @@ # 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. +As user of Example orga, +you can setup any [Micropub] client +and then add and edit [article] posts +on Example orga website(s). +[Micropub]: + "Micropub - open standard for simple web content editing" -## Recommended client +[article]: + "article - Micropub item containing html (e.g. a blog post)" -[TODO] + +## Special strings + +NB! This documentation uses special strings +which you may want to adapt for your local setup: + +micropubhost: micropub.example.org +domain: example.org + +organisation: Example orga + + +## Clients + +Example orga web content uses Micropub, +that is accessed with any of several [Micropub clients]. + +Recommended is to use the [Indigenous] client, +available for desktop, Android and ios. + +You can use several clients at once. + +[Micropub clients]: + "Overview of Micropub clients" + +[Indigenous]: + "Indigenous - app to interact with Micropub and Microsub services" ## Access rights -[TODO] +Micropub handles access control using [IndieAuth]. + +FIXME + +[IndieAuth]: + "IndieAuth - decentralized identity protocol on top of OAuth 2.0" diff --git a/USE.md b/USE.md index 223031d..ced52c1 100644 --- a/USE.md +++ b/USE.md @@ -1,19 +1,22 @@ # Edit a website -Use your [Micropub](https://indieweb.org/Micropub) client +Use your [Micropub] client to add articles or edit existing ones. +[Micropub]: + "Micropub - open standard for simple web content editing" + ## Add -[TODO] +FIXME ## Replace -[TODO] +FIXME ## Delete -[TODO] +FIXME -- cgit v1.2.3