From c3f83812ca40ccb6df03ab918f3337407eeb9346 Mon Sep 17 00:00:00 2001 From: dakkar Date: Tue, 19 Dec 2023 09:41:07 +0000 Subject: [PATCH 1/3] fancier get-new-changes script it can now handle any number of repos --- tools/get-new-changes | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/tools/get-new-changes b/tools/get-new-changes index 14358f5..a0f8fc2 100755 --- a/tools/get-new-changes +++ b/tools/get-new-changes @@ -4,17 +4,31 @@ # upstream) since the last_commit_checked; this is handy to update the # content/en/docs/comparsion/misskey.md file -# set up a git clone like this: +# set up a set of git clones like this: # # git clone -o sharkey -b stable https://github.com/transfem-org/Sharkey.git # cd Sharkey # git remote add misskey https://github.com/misskey-dev/misskey.git # git remote update -p +# cd .. +# git clone -o sharkey -b stable git@git.joinsharkey.org:Sharkey/sfm.js +# cd sfm.js +# git remote add misskey https://github.com/misskey-dev/mfm.js.git +# git remote update -p +# cd .. # run this program from the root of that clone, update the comparison -# document, edit the `last_commit_checked` to be the output of `git -# rev-parse sharkey/stable`, commit all the changes +# document, edit each `last_commit_checked` to be the output of `git +# rev-parse sharkey/stable` in the corresponding clone, commit all the +# changes + +declare -A last_commit_checked=( + ["sharkey"]=10222804655445e8c9f6be4203fd566132de2e50 + ["sfm.js"]=0448eedb812fd300fbf12257c9960a914d48613c +) -last_commit_checked=10222804655445e8c9f6be4203fd566132de2e50 +log_cmd=( git log -u -b --word-diff=color --word-diff-regex='[[:alnum:]_]+|[^[:space:]]' --no-merges ) -exec git cmplog sharkey/stable ^misskey/develop ^"${last_commit_checked}" +for repo in "${!last_commit_checked[@]}"; do + ( cd "$repo"; exec "${log_cmd[@]}" sharkey/stable ^misskey/develop ^"${last_commit_checked[$repo]}"; ) +done From 6683ba344df75446ec04d95195892313f551447d Mon Sep 17 00:00:00 2001 From: dakkar Date: Tue, 19 Dec 2023 10:33:59 +0000 Subject: [PATCH 2/3] overview page, faq page (#4) --- content/en/docs/getting-started/_index.md | 5 +++ content/en/docs/getting-started/overview.md | 28 +++++++++++++++ content/en/docs/install/faqs.md | 39 +++++++++++++++++++++ layouts/index.html | 6 ++-- 4 files changed, 75 insertions(+), 3 deletions(-) create mode 100644 content/en/docs/getting-started/_index.md create mode 100644 content/en/docs/getting-started/overview.md create mode 100644 content/en/docs/install/faqs.md diff --git a/content/en/docs/getting-started/_index.md b/content/en/docs/getting-started/_index.md new file mode 100644 index 0000000..0fb71c7 --- /dev/null +++ b/content/en/docs/getting-started/_index.md @@ -0,0 +1,5 @@ +--- +title: "Getting started" +weight: 100 +toc: true +--- diff --git a/content/en/docs/getting-started/overview.md b/content/en/docs/getting-started/overview.md new file mode 100644 index 0000000..adb31ac --- /dev/null +++ b/content/en/docs/getting-started/overview.md @@ -0,0 +1,28 @@ +--- +title: "Overview" +weight: 110 +toc: false +--- + +Welcome to Sharkey's documentation! + +Sharkey is a Misskey fork following upstream changes when possible, +with added features. Like any other ActivityPub software Sharkey can +interface with the thousands of servers that form the fediverse, an +interconnected social network, working in tandem with software such as +Akkoma, Mastodon, Pixelfed and many more. + +Have you heard of Sharkey, but you're not sure how it differs from +Misskey? [Go to the comparison page](/docs/comparsion/misskey/). + +Do you want to find an instance running Sharkey, and create an account +there? [Go to our directory site](https://joinsharkey.org/). + +Do you want to install Sharkey? [Go to the "Fresh Install" +instructions](/docs/install/fresh/). + +Are you running a Misskey or Firefish instance, and want to migrate to +Sharkey? [Go the migration instructions](/docs/install/migrate/). + +Have you just started using Sharkey, and are confused? [Try the +FAQs](/docs/install/faqs/). diff --git a/content/en/docs/install/faqs.md b/content/en/docs/install/faqs.md new file mode 100644 index 0000000..2ac5f1d --- /dev/null +++ b/content/en/docs/install/faqs.md @@ -0,0 +1,39 @@ +--- +title: "FAQs" +weight: 4000 +toc: false +--- + +# How do I enable note search? + +You use the "roles" system. Log in as administrator, go to the +"control panel", select the "roles" section (under "management"). Then +either expand the "role template" (if you want to give every user +access to search) or create a new role (if you want to give access to +only some users), then change the "**Usage of note search**" setting. + +# How do I give my users more Drive space? + +You use the "roles" system. Log in as administrator, go to the +"control panel", select the "roles" section (under "management"). Then +either expand the "role template" (if you want to give every user the +same amount space) or create a new role (if you want to give different +amounts of space to different users), then change the "**Drive +capacity**" setting. + +# How do I enable push notifications for the web interface? + +First of all, you need to generate a pair of so-called "VAPID" keys. + +One way to do that is, from your Sharkey directory (git clone, or +inside the Docker image): + + ./packages/backend/node_modules/.bin/web-push generate-vapid-keys + +Alternatively, you can use [an online +generator](https://www.stephane-quantin.com/en/tools/generators/vapid-keys). + +Once you have that public and private keys, log in as administrator, +go to the "control panel", select the "general" section (under +"settings"), scroll to the "ServiceWorker" bit, enter both keys, and +enable the "Enable Push-Notifications for your Browser" toggle. diff --git a/layouts/index.html b/layouts/index.html index 0fdb4d8..75dcbc3 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -1,4 +1,4 @@ - + \ No newline at end of file + window.location.href = "/docs/getting-started/overview" + From 10221a2babd72d105ddff3410229d7945d10295b Mon Sep 17 00:00:00 2001 From: dakkar Date: Tue, 19 Dec 2023 10:42:48 +0000 Subject: [PATCH 3/3] fix repo URLs in the script --- tools/get-new-changes | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/get-new-changes b/tools/get-new-changes index a0f8fc2..e0f5d55 100755 --- a/tools/get-new-changes +++ b/tools/get-new-changes @@ -6,12 +6,12 @@ # set up a set of git clones like this: # -# git clone -o sharkey -b stable https://github.com/transfem-org/Sharkey.git +# git clone -o sharkey -b stable https://git.joinsharkey.org/Sharkey/Sharkey.git # cd Sharkey # git remote add misskey https://github.com/misskey-dev/misskey.git # git remote update -p # cd .. -# git clone -o sharkey -b stable git@git.joinsharkey.org:Sharkey/sfm.js +# git clone -o sharkey -b stable https://git.joinsharkey.org/Sharkey/sfm.js # cd sfm.js # git remote add misskey https://github.com/misskey-dev/mfm.js.git # git remote update -p