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

How to edit a single page on a LifeItself website #6

Open olayway opened 1 year ago

olayway commented 1 year ago

Job story

As a new contributor to a Flowershow/PortalJS site (e.g. LifeItself.org), I want to edit an existing page on the website (whose contents are stored on GitHub), i.e. add/change some text, edit/add links to other pages, and/or add images to it so that the page is updated.

Tasks

olayway commented 1 year ago

@ZybN

I've created a very simple draft of the tutorial. The gist of it we already had in our mindmap, so I've added a screenshot of it instead of writing it over again. You can adjust the structure of the draft if you want (add, rename headings, etc.).

I've also created a sandbox app that people following the tutorial can use to test the flow before they attempt to make changes in the target website repo (see links in the issue description). You can also use it while writing the tutorial to go through all the steps we're trying to document and to make sure we don't miss anything.

For now please just write the raw content, no screenshots are needed. Once we have the copy, we'll maybe add just a few screenshots and record the video tutorial to show the rest (e.g. where you need to navigate to or click). That being said, you don't need to go into extreme details when writing the steps in the tutorial - these can be shown in the video.

olayway commented 1 year ago

@ZybN I've seen your draft. The steps are more or less correct but can you please write the whole tutorial draft? I mean, the tutorial shouldn't include just the 1, 2, 3... steps. It's a whole piece of writing, which could probably use some intro, some summary etc. That's why I prepared the skeleton in hackmd in the first place, which you were supposed to use - fill in with content (and ofc adjust if needed). Does that make sense?