Closed rufuspollock closed 10 months ago
Useful How to's for newer members of the team, or less frequently completed actions
FIXED. Moved to https://github.com/datopian/makeitmarkdown/blob/main/design.md
DUPLICATE. Merging this back into the parent epic for now. No need for a separate issue.
Job stories for editor guide(s) (what 'How to...?' questions are wanting to be answered?)
Personas
Who are we writing for?
We are writing for non-technical people i.e. not developers. That said, in most tutorials we are assuming ...
Later we will add support for learning these too.
If writing for devs we will flag that
If we are writing for a developer/technical editor we will flag that and say e.g. "dev editor" or something like that ...
Personas List
Our personas and their skill levels.
Job Story
When writing documentation and guide for editing markdown + Flowershow/PortalJS based sites I want job stories so that I know what to prioritize to write and what i should be addressing
Acceptance
Tasks
Job Stories
4 high level jobs / journeys
And a combo one: (very common actually)
And a sixth "meta" story:
Sharing and Publishing: distinct functionality relevant to each high level job story
For each of the above you have a spectrum of potential sharing that relates to "where" you are doing this:
A common user journey goes from personal/local first to sharing to publishing on the web.
Put text on the web
Publish Collections
Publish Data
TODO
Knowledge garden
Why use this approach (POGM)?
TODO: still needs refactoring ...
There are lots of ways to address these different needs from classic CMS and blog platforms like wordpress to wikis etc.
However, few of them use markdown (so why use markdown)
Our contention is that a markdown-based approach using PortalJS/Flowershow/Markdown integrated toolkit is really great because ...
❗️ List of howtos to be written
Put text on the web
Knowledge garden
Publish Collections
Collaboration
⬇️ LifeItself-specific
Notes
Nathen https://github.com/orgs/life-itself/discussions/393#discussioncomment-5460864
How to correct a pull request
One thing I keep getting stuck on is how to not include changes into a pull request and to remove those changes as if they didn't happen. For now I just commit and then do the fixes, but this seems inefficient.
Other questions
Zaib https://github.com/orgs/life-itself/discussions/393#discussioncomment-5502358
I have learned how to use Obsidian from Nathen, he showed me how to use it and we recorded the video. I followed the video later to create the project pages and people page. The problems I encountered are:
I have a clear understanding of these right now, but in the start it was confusing. A walk-through guide in navigating GitHub and Obsidian would be very helpful for people just getting started.
Rufus https://github.com/orgs/life-itself/discussions/393#discussioncomment-5461119