Editor guide

[rufuspollock]

Guide for people contributing content or managing contribution of "wiki" content (so not front page but pretty much all other pages)

Acceptance

• page exists on site for this e.g. /meta/guide or /meta/editing Guide is linked on this page of website: https://web3.lifeitself.us/meta/editing
• has basic instructions for editing the site Guide includes instructions for editing directly on github and for editing using code editor or obsidian
• Get involved section added to front page
  • commit: Get-Involved.js
• Document frontmatter fields from Frontmatter for deep dive pages - including editor instructions #114 in editing guide

Tasks

Guide is finished and has been reviewed by @khalilcodes. Link to guide has been added to /meta/editing.md.

• Stub a page
• Introduction: Explain how site works and how you can edit See draft guide in progress here.
  • Wiki-like with sections
  • Technical architecture (?)
  • Use markdown
  • Editing
    • Edit direct on github
    • (More sophisticated) clone the repo and edit locally (using obsidian)
• Markdown: this section introduces you to markdown. Already done here so can reference https://playbook.datopian.com/markdown/
• Frontmatter: briefly explain what is frontmatter and why it is useful (look up in Obsidian info?)
  * [ ] Publishing flow: explain how the site gets published - mostly useful for developers but helps editors understand how stuff goes from github to the site **CT I don't think further detail on this beyond what is already implicit in the guide is necessary**
  * Github
  * Obsidian - our default editor. Markdown plus wiki stuff
• explain how we want to put in youtube videos (simpler and we get responsive) included in frontmatter section
• mention the deep dive template in editing guide in deep dive section
  * [ ] Add link to completed editor guide to README?
• Add link to /meta/editing.md
• Edit contribute page to link to /meta/editing.md.

[sdiehl]

Right now I'm just distributing .docx files to other academics. But it would be great if we could onboard people onto the Obsidian workflow. I can write up a quick intro but even Edit on Github is still probably slightly above the level of most of the people I would target for feedback though. Not sure how to get around this but open to ideas.

[rufuspollock]

Right now I'm just distributing .docx files to other academics. But it would be great if we could onboard people onto the Obsidian workflow. I can write up a quick intro but even Edit on Github is still probably slightly above the level of most of the people I would target for feedback though. Not sure how to get around this but open to ideas.

I think we can start with the editor guide for "editors" ie. people translating material into the system we have. We can accept that for other contributors they edit in their system of choice e.g. docx and we translate.

[EilidhRoss1]

@catherinet1 will be taking on this task. I have handed it over and she is fully briefed on what is needing done, and the progress that has already been made. Catherine, I've uploaded the video tutorial Khalil and I recorded to the google drive. Here's the link

[catherinet1]

Updated issue so that @EilidhRoss1 knows current status of editor guide draft while I am away.

[catherinet1]

@khalilcodes Please could you review the few sections highlighted in green in this draft of the editor guide to check they are correct and add any clarifying comments? They are some more technical bits which I researched myself so would value them being checked by someone with more technical experience.

[catherinet1]

FIXED. Editor guide completed and linked on website. Guide can be found on website here

[rufuspollock]

@catherinet1 would encourage in the FIXED comment to actually link to the guide. Otherwise i get the notification and have to dig around in the issue and/or site in order to find the guide and review it.

Also acceptance criteria aren't updated - cf https://tao.lifeitself.us/issues/#completing-tasks (e.g. a brief comment on what are the brief editing instructions or even direct link to the section in the guide would be great)