-
Notifications
You must be signed in to change notification settings - Fork 8
GH Wiki Tips
PLEASE EDIT and REFINE THIS DOCUMENT TO HELP US IMPROVE IT.
This page contains tips for maintaining ARK community content on the Github (GH) wiki platform, which is mainly used to host ARKA Working Group (WG) documents.
Like every GH repo(sitory), the repo at github.com/arks-org/arks.github.io gets a free wiki, accessible at the repo's URL after appending "/wiki". Although that repo/wiki is itself public, it links off to a separate, private repo/wiki for the NAAN WG documents.
If you know markdown well enough, you can always imitate markdown that you find on the wiki (seen by opening as if in edit mode). GH wiki editing gives a basic overview. GH markdown has less functionality than GH wiki markdown.
Ways to cope are being worked out, some described in this document. Simple HTML, such as the addition of <br>, can help formatting inside tables. Recording dialog (who said what) in a way that separates speakers with newlines may work better as seprate bullets in a bulleted list.
Most maintenance will be done by hand via the web UI, but it is possible (and sometimes necessary) to clone the repo to a laptop, edit locally, and push changes back to the repo.
Editing ARKA WG meeting agendas, which are combined with notes, is a very common task. Each WG has a page (a sort of virtual wiki) that lists the most recent meetings first.
To create a new meeting agenda for a given date, copy the most recent meeting link, change the date (keeping the date format), and save. Then copy the most recent meeting content to your clipboard and click the link you just created (which should be red to indicate that it doesn't exist yet), and that should open a new empty document. Paste in the previous meeting content, which preserves the formatting even if the content is incorrect. Finally, make appropriate changes for the new meeting.
Note: do not add hyphens to the github filename. If you do so your page will effectively disappear; in page titles all, hyphens are automatically replaced by spaces, so YYYY-MM-DD becomes YYYY MM DD.
Access URLs can address parts of the repo file hierarchy, but each "leaf" must be unique wherever it appears in the file hierarchy. So if two files occur in different directories, only one of them is visible to wiki users.
As mentioned, when given the opportunity to modify the filename in the UI, do NOT enter hyphens; use spaces instead, which will become hyphens in filenames and access links. (Using hyphens will give you a world of pain and invisible files, the only fix being to clone the repo, and do something like git pull; git mv '2024'$'\342\200\220''08'$'\342\200\220''13-Technical-WG-Agenda-and-Notes.md' 2024-08-13-Technical-WG-Agenda-and-Notes.md. Better just not to do it.)
Viewing wiki change history is different from viewing general GH change history. Basically, visit the page you're interested in, and under the link name at the top should be a "revisions" link that you can click on.