datopian / makeitmarkdown

Learn how to make markdown based websites, docs, knowledgebases and more - and why a markdown based approach is awesome πŸ¦Έβ€β™€
https://makeitmarkdown.com
MIT License
5 stars 0 forks source link

[EPIC] Editor guide: how to contribute content and datasets #1

Open rufuspollock opened 1 year ago

rufuspollock commented 1 year ago

Create a first editor guide for adding and editing conten to a markdown-based site -- specifically a markdown-based, flowershow-published site and even more specifically a "MOGF" (markdown-obsidian-github-flowershow built site).

Outcome visioning 🎯 (High level acceptance)

A non-dev editor/author at Life Itself or anywhere else has a single online place to go to with (or linking to) sufficient docs to autonomously (i.e. without dev support) ...

Plan of work

Prep

- [x] Merge in (and then close as duplicate) https://github.com/life-itself/community/issues/519 **βœ…2023-05-24**
- [x] Merge in and then close https://github.com/orgs/life-itself/discussions/393 **βœ…2023-05-24**
- [x] Define editing tools / process **βœ…2023-06-06 we will use the same stack we are documenting! i.e. MGF (markdown, github, flowershow)**
- [x] βž•2023-06-06 Review and tidy existing epic https://github.com/datopian/makeitmarkdown/issues/1 **βœ…2023-06-06 split out job stories task, tidied up acceptance and tasks**
- [x] Outline purpose of consolidated guide and define acceptance **βœ…2023-06-06 good enough for now. see SCQA above + purpose and principles in https://github.com/datopian/portaljs/discussions/927 (may need some refinement and consolidation here)**
- [x] Instructions on how to create documentation **βœ…2023-06-06 see https://github.com/datopian/portaljs/discussions/929**
- [x] #4
- [x] #5
- [x] Decide where we publish **βœ…2023-12-14 publish on makeitmarkdown**

Content

https://coggle.it/diagram/ZG5bpZ-I6DjyVLxZ/t/editor-guide-latest-this-part-is-initial-2023-5-24-14-01

Misc

rufuspollock commented 9 months ago

UPDATE: 2023-11-01

Current outstanding work

Sketch of the Guide