From 2eeacd28696152aa2e4ee17ce825488335cad4d0 Mon Sep 17 00:00:00 2001 From: michael Date: Thu, 18 Jan 2024 07:18:43 -0800 Subject: [PATCH 1/2] added move-wiki-from-GitHub rfc --- ...iki-from-GitHub-and-host-as-static-site.md | 50 +++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 rfcs/0000-move-wiki-from-GitHub-and-host-as-static-site.md diff --git a/rfcs/0000-move-wiki-from-GitHub-and-host-as-static-site.md b/rfcs/0000-move-wiki-from-GitHub-and-host-as-static-site.md new file mode 100644 index 0000000..f40aea7 --- /dev/null +++ b/rfcs/0000-move-wiki-from-GitHub-and-host-as-static-site.md @@ -0,0 +1,50 @@ +- Title: Move Wiki from GitHub and convert to a static site +- Date proposed:2024-01-17 +- RFC PR: https://github.com/supercollider/rfcs/pull/0000 **update this number after RFC PR has been filed** + +# Summary + +Move the wiki from Github to wiki.supercollider.online. Use [Sphinx](https://www.sphinx-doc.org/en/master/) to generate a static site. + +# Motivation + +A wiki is hopefully a permanent reference. + +But in the history of SC, there has already been (at least?) one abandoned wiki that was migrated to the GitHub wiki, and while GitHub is a convenient place, [it may not a place we should support.][https://sfconservancy.org/GiveUpGitHub/] + +Moving to out of GitHub would allow the community to take ownership of the wiki URL and be independent of the code hosting platform, providing a permanent location for precious information. + +This would also prepare the community/wiki in case GitHub needs to be evacuated. + +A static site would also have many advantages: +- independence of any hosting platform - hosting a static website can be easily done these days +- searching the wiki +- editing can be performed offline +- internal references can be checked for dead links at build time +- custom styling +- Clear PR workflow +- website structure is independent of folder structure, which allows to improve the organization of files + +please see discussion here: [6181](https://github.com/supercollider/supercollider/issues/6181) +and on the forum [here](https://scsynth.org/t/the-sc-wiki/8123/11?u=semiquaver) + +# Specification + +As a proof of concept I cloned the existing wiki and converted it to a Sphinx website - this means that the history of most pages is untouched, preserving valuable git history (see https://github.com/capital-G/supercollider-wiki/blame/main/docs/contributing/workflow/Unit-Testing-Guide.md) + +Repo: https://github.com/capital-G/supercollider-wiki +Website: https://capital-g.github.io/supercollider-wiki/ + +Edit buttons were added to pages that drop users into the repo where they can edit and make pull requests in the browser. + +Further work on style and structure could be done using a PR workflow + +# Drawbacks + +The only drawback that surfaced in the discussions so far was relative ease of contribution. There are online wiki systems that allow users to edit directly in the browser. This proposal would limit contributors to those people comfortable with a git PR workflow. + + + + +# Unresolved Questions + From 9a1011bb2f82d9459316ba4b1cc6bdc815318444 Mon Sep 17 00:00:00 2001 From: "Michael Webster (semiquaver)" Date: Wed, 22 May 2024 19:03:43 -0700 Subject: [PATCH 2/2] Update and rename 0000-move-wiki-from-GitHub-and-host-as-static-site.md to 0021-move-wiki-from-GitHub-and-host-as-static-site.md update RFC numbers --- ...md => 0021-move-wiki-from-GitHub-and-host-as-static-site.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename rfcs/{0000-move-wiki-from-GitHub-and-host-as-static-site.md => 0021-move-wiki-from-GitHub-and-host-as-static-site.md} (97%) diff --git a/rfcs/0000-move-wiki-from-GitHub-and-host-as-static-site.md b/rfcs/0021-move-wiki-from-GitHub-and-host-as-static-site.md similarity index 97% rename from rfcs/0000-move-wiki-from-GitHub-and-host-as-static-site.md rename to rfcs/0021-move-wiki-from-GitHub-and-host-as-static-site.md index f40aea7..aae07c2 100644 --- a/rfcs/0000-move-wiki-from-GitHub-and-host-as-static-site.md +++ b/rfcs/0021-move-wiki-from-GitHub-and-host-as-static-site.md @@ -1,6 +1,6 @@ - Title: Move Wiki from GitHub and convert to a static site - Date proposed:2024-01-17 -- RFC PR: https://github.com/supercollider/rfcs/pull/0000 **update this number after RFC PR has been filed** +- RFC PR: https://github.com/supercollider/rfcs/pull/0021 **update this number after RFC PR has been filed** # Summary