add onboarding

Author: vonKristoff

readme.md

@@ -1,24 +1,85 @@
-# Example Static Content Repo For Wiki Instances
-![Arcetypal Repo](archetypal-heading.jpg)
-1. Sync Markdown content into `content` directory to be consumed by private Wiki Instance.
-2. Markdown can be Frontmatter decorated.
-3. Ensure Repo emits `dispatch.yml` to trigger workflow in order to rebuild site once content updates.
-    * create repo secret: `REPO_PAT` : `paste in org PAT - github_pat_***`
-      * requires Organisaztion PAT
-      * Read access to metadata
-      * Read & Write to Contents
-    * create repo variable: `REPO`:  `owner/wiki-content--example`
-    * create repo variable: `EVENT` and use value: `TRIGGER_BUILD`
-4. Connect workflows with other REPO by having a consuming end:
-*workflow*
+![Arcetypal Repo](static/archetypal-heading.jpg)
+
+# Onboarding
+
+_Please deprecate this process once setup!_
+
+> We are aligning so we can keep track of the cards in codecks, and acknowledge **who is accountable** to which site and its **priority**
+
+**Dashboard**
+https://microsites-dashboard.fly.dev/
+
+![](static/microsite-thumb-nfo.jpg)
+
+### Github repo naming convention
+
+Finding a repo can be hard when there's so many. We use this BEM naming convention so we can navigate URLs easily.
+
+`[organisation]/[site-type]-[repo-type]--[project]`
+
+- site-type: `wiki | press | site`
+- repo-type: `host | content`
+- project: `offgrid | etc`
+
+> _For this **content** context, you will probably only need to use content type_
+
+`semaeopus/wiki-content--offgrid`
+
+### Content
+
+Offgrid Wiki - can we use https://codebeautify.org/html-to-markdown
+
+Make changes to the content repo, and the site rebuilds.
+
+### Issues & Feature requests
+
+Report them to the Discord `#wiki-making` channel.
+
+---
+
+## Onboarding Checklist
+
+- Github Account
+- Get added to Semaeopus Team on Github
+- Use [Desktop](https://desktop.github.com/download/) app for sync
+- Use [Obsidan](https://obsidian.md/) for markdown content
+- Pull a `content` site (using GH app)
+- Connect repo to Obsidian vault
+
+Strategy for Obsidian
+
+![](static/obsid-nfo.jpg)
+
+You will want to open the vault at the **root** of the repo.
+This will contain the following:
+
 ```
-on:
-    repository_dispatch:
-        types:
-            - TRIGGER_BUILD
+readme.md
+static/
+content/
+	attachments/
+	Your Content.md
 ```
+
+plus some hidden files
+
+_The plan was_ to open the vault at `content` itself, but Obsidian renames the `content` directory as the respective `vault` name, which then screws publication.
+
+> There is a way around this whereby we name the content as the preferred vault name and pass this to the _build step_ as a **Github variable**.
+
+### images
+
+You can drag in from your machine ... but we need to sync them too!
+So we set up the Obsidian vault to use the `attachments` directory.
+
+We also **disable** wikilinks, so file paths are maintained.
+
+![](static/settings.jpg)
+
 ### Frontmatter
+
 Current available fields:
+
 ```
 ---
 description: SEO powers for wiki specific page
@@ -29,6 +90,7 @@ tags: ['blog']
 ```
 
 ---
+
 ## Welcome to Community content
 
 This would be a community facing **public** repo.