From 44791ee370ba6daa35b0e934aea439a4caaaac68 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= <anarcat@debian.org> Date: Thu, 9 Feb 2023 13:58:35 -0500 Subject: [PATCH] document the web interface editing workflow more explicitly --- service/documentation.md | 50 +++++++++++++++++++++++++++++++++++----- 1 file changed, 44 insertions(+), 6 deletions(-) diff --git a/service/documentation.md b/service/documentation.md index 07690c2c..c195ae18 100644 --- a/service/documentation.md +++ b/service/documentation.md @@ -14,7 +14,7 @@ for the status page at <https://status.torproject.org>. <!-- test --> -## Editing the wiki +## Editing the wiki through the web interface If you have the right privileges (currently: being part of TPA, but we hope to improve this), you should have an `Edit` button at the @@ -22,13 +22,51 @@ top-right of pages in the wiki here: <https://gitlab.torproject.org/tpo/tpa/team/-/wikis/> -If not, you need to issue a merge request in the [wiki replica][]. +If not (which is more likely), you need to issue a merge request in +the [wiki replica][]. At this URL: -[wiki replica]: https://gitlab.torproject.org/tpo/tpa/wiki-replica +<https://gitlab.torproject.org/tpo/tpa/wiki-replica> + +You will see a list of directories and files that constitute all the +pages of the wiki. You need to browse this to find a file you are +interested in editing. You are most likely to edit a [service +page](https://gitlab.torproject.org/tpo/tpa/wiki-replica/-/tree/master/service), say you want to edit this very page. + + 1. Find the [documentation.md](https://gitlab.torproject.org/tpo/tpa/wiki-replica/-/blob/master/service/documentation.md) file in the [service directory](https://gitlab.torproject.org/tpo/tpa/wiki-replica/-/tree/master/service) + and click it + + 2. You should see a "Open in Web IDE" button. If you want the full + GitLab experience, click that button and good luck. Otherwise, + click the arrow to the right and select "Edit" than click the + "Edit" button. + + 3. You should now see a text editor with the file content. Make a + change, say add: + + <!-- test --> + + At the top of the file. -Because the wiki is actually mirrored to a git repository, it might be -preferable to edit the Git repository and push there, so that the -replica is up to date. See further instructions below. + 4. Enter a "Commit message" in the field below. Explain why you are + making the change. + + 5. Leave the "Target Branch" unchanged + + 6. Click "Commit changes". This will send you to a "New merge + request" page. + + 7. Review and expand the merge request description, which is based on + the previously filled commit message (optional) + + 8. Leave all the check boxes as is. + + 9. Click "Create merge request". + + 10. The wiki administrators will review your request and approve, + reject, or request changes on it shortly. Once approved, your + changes should be visible in the wiki. + +[wiki replica]: https://gitlab.torproject.org/tpo/tpa/wiki-replica # How-to -- GitLab