Merge pull request 'Add and/or replace GitHub with Gitea' (#98) from gitea into main

Reviewed-on: plume/documentation#98
3 years ago · 6800a199f9
parent 41756182d5 dafd7c1b90
commit 6800a199f9
15 changed files with 56 additions and 47 deletions
--- a/source/_nav.erb
+++ b/source/_nav.erb
@ -4,10 +4,10 @@
    <a href="https://joinplu.me"><img src="/images/logo.svg" alt="Plume logo">Plume</a>
   </li>
    <li>
-       <a href="https://contribute.joinplu.me/">Contribute</a>
+       <a href="/contribute/">Contribute</a>
    </li>
    <li>
-       <a href="https://github.com/Plume-org/Plume">Source code</a>
+       <a href="https://git.joinplu.me/Plume/Plume">Source code</a>
    </li>
    <li>
       <a href="https://riot.im/app/#/room/#plume:disroot.org">Chat room</a>
--- a/source/contribute/bug-report.html.md
+++ b/source/contribute/bug-report.html.md
@ -8,16 +8,16 @@ time: 5 minutes
 Plume is probably not perfect, and may contain bugs. If you see something that seems
 abnormal (unexpected behavior, display issue, a grammar mistake, etc), you can report it, so that we can fix it.

-## If you have a GitHub account
+## If you have a Gitea or GitHub account

-If the issue is about Plume itself, go on [this page](https://github.com/Plume-org/Plume/issues/new?assignees=&labels=C%3A+Bug&template=bug_report.md&title=).
+If the issue is about Plume itself, go on [Gitea issues page](https://git.joinplu.me/Plume/Plume/issues/new) or [GitHub issues page](https://github.com/Plume-org/Plume/issues/new?assignees=&labels=C%3A+Bug&template=bug_report.md&title=).
 Then, all you have to do is to fill the title and the description of your issue, and to validate.

-If your issue isn't about Plume itself, find the appropriate repository [in the list](https://github.com/Plume-org), go to the "Issues"
+If your issue isn't about Plume itself, find the appropriate repository [in the list](https://git.joinplu.me/Plume)([GitHub](https://github.com/Plume-org)), go to the "Issues"
 tab, click the green "New issue" button, and describe your problem.

-## If you don't have a GitHub account
+## If you don't have a Gitea nor GitHub account

-If you don't have a GitHub account, and don't want to create one, you can also report your issue on Matrix.
+If you don't have a Gitea nor GitHub account, and don't want to create one, you can also report your issue on Matrix.
 Join the Plume room as explained in [this guide](/contribute/discussion), and send a message explaining what is wrong.
-We will take care of creating an issue on GitHub for you.
+We will take care of creating an issue on Gitea or GitHub for you.
--- a/source/contribute/code-review.html.md
+++ b/source/contribute/code-review.html.md
@ -6,10 +6,10 @@ time: 30 minutes
 ---

 Some people contribute to Plume by improving it's source code. They propose changes to the
-software throught what is called "pull requests" on GitHub (thus you will need to create a GitHub
-account to follow this guide, if you don't have one yet).
+software throught what is called "pull requests" on Gitea or GitHub (thus you will need to create a Gitea
+or GitHub account to follow this guide, if you don't have one yet).

-Here is the [list of all pull requests needing to be reviewed](https://github.com/Plume-org/Plume/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc+review%3Arequired+label%3A%22S%3A+Ready+for+review%22).
+Here is the [list of all pull requests needing to be reviewed]()([GitHub](https://github.com/Plume-org/Plume/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc+review%3Arequired+label%3A%22S%3A+Ready+for+review%22)).
 Choose one that seems interesting to you, read the discussion for context about what needs to be reviewed,
 and what was already tested, and start your review.

@ -36,7 +36,7 @@ If you know one of the programming languages used in Plume (Rust, SCSS, HTML and
 of the code: give advices about it's efficiency, ask for clarification if you are not sure what it does, point out potential
 bugs, etc.

-You can do that by going to the "Files changed" tab on the page of pull request on GitHub. Then you will be able to comment on the
+You can do that by going to the "Files changed" tab on the page of pull request on Gitea or GitHub. Then you will be able to comment on the
 diff, as seen in this GIF:

 ![Commenting on the diff](/images/code-review.gif)
@ -45,7 +45,7 @@ diff, as seen in this GIF:

 Once you tested the changes, you need to tell to the person who proposed the pull request what you found.

-The best way to do that is to go to the "Files changed" tabs on the GitHub pull request, and to click the green "Review
+The best way to do that is to go to the "Files changed" tabs on the Gitea or GitHub pull request, and to click the green "Review
 changes" button, in the top right corner. Then write a comment in the box that appears, explaining what worked, and what went
 wrong. Don't hesitate to give precise information, explaining how to reproduce issues for instance. When making comments
 about someone else's work, be kind, and try to make constructive critics.
--- a/source/contribute/development.html.md
+++ b/source/contribute/development.html.md
@ -10,7 +10,7 @@ Plume is mostly made in Rust. The back-end uses Rocket and Diesel. The front-end
 is in Rust too, thanks to WebAssembly. The stylesheets are written in SCSS.

 If you want to write some code but you don't really know where to start, you
-can try to find [an issue that interests you](https://github.com/Plume-org/Plume/issues).
+can try to find [an issue that interests you](https://git.joinplu.me/Plume/Plume/issues))([GitHub](https://github.com/Plume-org/Plume/issues)).

 Then, fork Plume (if you didn't already do it), `git clone` your fork, and start a
 new branch with `git checkout -b NAME-OF-THE-BRANCH`. You can now start to work on the
@ -18,7 +18,7 @@ issue.

 Once you have something working, do `git add FILES THAT YOU CHANGED` (or `git add .` to add them all),
 and then `git commit`. Write a message explaining your changes, and do `git push origin NAME-OF-THE-BRANCH`
-to upload your work to GitHub. Open the URL that appears in the output of this last command to open
+to upload your work to Gitea or GitHub. Open the URL that appears in the output of this last command to open
 a pull request, that we will then review, and eventually merge.

 ## Installing the development environment
@ -150,7 +150,7 @@ second the string to translate. You can specify format arguments after a `;`.
 If your string vary depending on the number of elements, provide the plural version
 as the third arguments, and the number of element as the first format argument.

-You can find example uses of this macro [here](https://github.com/Plume-org/gettext-macros#example).
+You can find example uses of this macro [here](https://git.joinplu.me/plume/gettext-macros#user-content-example).

 There is no need to provide individual translations of  `i18n!`-wrapped strings in pull requests.
 The strings will be uploaded to a third-party web service and translated automatically as
@ -170,7 +170,7 @@ If you want to become a manager on Crowdin too, ask us [on Matrix](https://matri

 Then, in `src/main.rs` and `plume-front/src/main.rs`, add the code corresponding to the language in the `init_i18n!` macro.
 If you don't know the code for the language: it is the name of the `.po` file, without the extension.
-Here is an exemple of [a Pull Request adding Persian](https://github.com/Plume-org/Plume/pull/782).
+Here is an exemple of [a Pull Request adding Persian](https://git.joinplu.me/Plume/Plume/pulls/782).

 `cargo check` to make sure everything compiles, and you are good to go!

--- a/source/contribute/documentation.html.md
+++ b/source/contribute/documentation.html.md
@ -7,7 +7,7 @@ time: 30 minutes

 Having an accurate, understandable and complete documentation is important.

-Our documentation is [hosted on GitHub](https://github.com/Plume-org/docs), so you
+Our documentation is [hosted on Gitea](https://git.joinplu.me/plume/documentation), so you
 will need an account here if you want to edit it. You will probably need to fork it
 to create a temporary copy you have the right to edit (with the button in the top right corner).

@ -37,17 +37,17 @@ Our current documentation is probably not perfect, and proof-reading it helps a
 this part only applies to the English documentation, if you want to improve the documentation in another language,
 see how to [translate it](/contribute/translations).

-To fix the mistakes you found, you will need to fork the documentation on GitHub (as explained in the first
+To fix the mistakes you found, you will need to fork the documentation on Gitea (as explained in the first
 paragraph of the previous part).

-Once it's done, choose the page you want to review, and find the corresponding file on GitHub (the URL of the page in
+Once it's done, choose the page you want to review, and find the corresponding file on Gitea (the URL of the page in
 the documentation and the name of the files are normally the same). Read the page to see if you can find typos, grammar
-mistakes, sentences that can be improved, etc. If you see anything that could be improved, go to GitHub and edit the file.
+mistakes, sentences that can be improved, etc. If you see anything that could be improved, go to Gitea and edit the file.


 ## Saving your work and proposing your changes

-Once you finished, you can save your work. To do that, GitHub asks you to make a short summary of your changes.
+Once you finished, you can save your work. To do that, Gitea asks you to make a short summary of your changes.

 ![The box to write a summary of your changes](/images/new-docs-page.png)

--- a/source/contribute/feature-request.html.md
+++ b/source/contribute/feature-request.html.md
@ -11,12 +11,12 @@ you have to propose.
 ## It may need to be discussed

 If your feature is controversial, or not totally clear yet, the best is to open a new issue
-on [Gitea](https://git.joinplu.me/Plume/Plume/issues) or [GitHub](https://github.com/Plume-org/Plume/issues/new?template=feature_request.md).
+on [Gitea](https://git.joinplu.me/Plume/Plume/issues/new) or [GitHub](https://github.com/Plume-org/Plume/issues/new?template=feature_request.md).
 Give as much details as possible. Especially, explain which problem you are trying to solve with this new feature.

 ## It doesn't really need to be discussed

-Then you can open on [Gitea](https://git.joinplu.me/Plume/Plume/issues) or
+Then you can open on [Gitea](https://git.joinplu.me/Plume/Plume/issues/new) or
 [GitHub](https://github.com/Plume-org/Plume/issues/new?template=feature_request.md),
 if you have an account there. Just fill the information asked in the form, and click "Submit new issue".

--- a/source/guide/creating-themes.html.md
+++ b/source/guide/creating-themes.html.md
@ -10,7 +10,7 @@ so all you need to know to write a theme is to know CSS.
 # Base template

 A good start can be the official base theme, that is written in SCSS, and that you can find
-[in Plume's repository](https://github.com/Plume-org/Plume/tree/master/assets/themes/default).
+[in Plume's repository](https://git.joinplu.me/Plume/Plume/src/branch/main/assets/themes/default).
 You can copy these files (they are under the AGPL-3.0 license), and start by changing the variables
 in `_variables.scss`. If you use this theme as a basis, the [SASS/SCSS](https://sass-lang.com/) will be
 needed to transform it to a single CSS file that an admin can install on their instance.
@ -18,7 +18,7 @@ needed to transform it to a single CSS file that an admin can install on their i
 To test your theme, you can install a browser extension like [*Stylish*](https://userstyles.org) and copy your CSS inside.

 Plume updates may sometimes break your theme (if we make a layout change, add a new CSS class, or so on).
-If you want to ensure your theme continues to work as Plume is developed, following [the project on GitHub](https://github.com/Plume-org/Plume/) can notify you when we make changes that might affect your theme.
+If you want to ensure your theme continues to work as Plume is developed, following [the project on Gitea](https://git.joinplu.me/Plume/Plume)([GitHub](https://github.com/Plume-org/Plume/)) can notify you when we make changes that might affect your theme.
 Pull requests and commits breaking themes are normally clearly identified as such.

 # Detailed explanations
--- a/source/guide/distant-interactions.html.md
+++ b/source/guide/distant-interactions.html.md
@ -25,7 +25,7 @@ For blogs it is `https://your.instance/~/name@other.instance`
 When opening a remote profile like that, Plume will fetch articles this person has already published.
 However, it can take some time, so try to refresh the page a few times if no articles appears on the first try.
 Also note that old articles are not yet fetched when viewing a remote blog for the first time
-(this issue will probably be fixed sooner or later, see [#542](https://github.com/Plume-org/Plume/issues/542) for updates).
+(this issue will probably be fixed sooner or later, see [#542](https://git.joinplu.me/Plume/Plume/issues/542) for updates).

 ## Start to federate

--- a/source/installation/with/prebuilt.html.md
+++ b/source/installation/with/prebuilt.html.md
@ -7,10 +7,9 @@ for other platforms may come in the future. For Windows users, try this [page](h

 You will need to have `wget` installed for this method to work.

-To download and install the latest release, first define the following variables in your shell:
+To download and install the latest release, first define the following variable in your shell:

- `PLUME_VERSION`: the Plume version to install. The latest is `0.5.0`.
- `PLUME_DB`: the database backend to use. Either `postgres` or `sqlite`.
+- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP or `sqlite` in the file name. Choose which you want.

 Then run these commands:

@ -22,7 +21,7 @@ mkdir Plume
 cd Plume

 # Download the files
-wget -O plume.tar.gz https://github.com/Plume-org/Plume/releases/download/$PLUME_VERSION/plume-$PLUME_DB.tar.gz
+wget -O plume.tar.gz $DOWNLOAD_URI
 # Extract them
 tar -xf plume.tar.gz
 mv bin/* ~/.cargo/bin/
--- a/source/installation/with/source-code.html.md
+++ b/source/installation/with/source-code.html.md
@ -5,7 +5,7 @@ title: Compiling from source
 The first step to compile Plume's source code is to get it.

 ```bash
-git clone https://github.com/Plume-org/Plume.git
+git clone https://git.joinplu.em/Plume/Plume.git
 cd Plume
 ```

--- a/source/organization/contributors.html.md
+++ b/source/organization/contributors.html.md
@ -14,6 +14,7 @@ Open for mentoring: yes

 Accounts:

+- Gitea: git.joinplu.me/kiwii
 - GitHub: BaptisteGelez
 - Matrix: @baptistegelez:disroot.org
 - Fediverse: @Ana@soc.punktrash.club (Pleroma), @Ana@fediverse.blog (Plume)
@ -34,6 +35,7 @@ Open for mentoring: yes

 Accounts:

+- Gitea: git.joinplu.me/igalic
 - GitHub: igalic
 - Matrix: @eenameename:matrix.org
 - Fediverse: @hirojin@dev.glitch.social (Professional), @meena@glitch.social (Personal)
@ -53,6 +55,7 @@ Open for mentoring: no, but feel free to ask questions when you need

 Accounts:

+- Gitea: git.joinplu.me/trinity-1686a
 - GitHub: fdb-hiroshima
 - Matrix: @fdb_hiroshima:matrix.org
 - Fediverse: @trinity@soc.punktrash.club (Pleroma), @FDB_hiroshima@fediverse.blog (Plume)
@ -65,5 +68,5 @@ Skills:

 ## Want to add yourself here?

-You can either [do it by yourself](https://github.com/Plume-org/docs/edit/master/source/organization/contributors.html.md)
-if you have a GitHub account, or give Ana all the required informations and she will add you (see above for contact information).
+You can either [do it by yourself](https://git.joinplu.me/plume/documentation/_edit/main/source/organization/contributors.html.md)
+if you have a Gitea account, or give Ana all the required informations and she will add you (see above for contact information).
--- a/source/organization/release-process.html.md
+++ b/source/organization/release-process.html.md
@ -17,10 +17,10 @@ major changes are made to the interface for example (even if the two are often l

 ## What gets in each version

-We don't set deadlines for new releases. We just assign issues (either bug to be fixed or feature requests) on GitHub to a given
+We don't set deadlines for new releases. We just assign issues (either bug to be fixed or feature requests) on Gitea to a given
 milestone as we feel it, and once it is complete, we make a new release.

-**[→ Milestones list on GitHub](https://github.com/Plume-org/Plume/milestones?direction=asc&sort=due_date)**
+**[→ Milestones list on  Gitea](hhttps://git.joinplu.me/Plume/Plume/milestones)**

 We should prefer making small releases often, than big ones once a year or so.

@ -38,7 +38,7 @@ We should make sure the documentation is up-to-date before publishing a release.
 The `dev` branch of the docs should be merged into `stable` to be deployed on [docs.joinplu.me](https://docs.joinplu.me).

 For each release, we make an announcement as a blog post (on Plume of course), a message on the Matrix room,
-and a more technical/impersonal changelog on the GitHub release page (basically a list of the PR that were merged
+and a more technical/impersonal changelog on the Gitea release page (basically a list of the PR that were merged
 since the last release). This last technical changelog should include any steps that should be taken for this specific
 update that are not listed in the general update documentation.

--- a/source/organization/where.html.md
+++ b/source/organization/where.html.md
@ -4,15 +4,23 @@ icon: share-2
 summary: 'Places where you can find Plume online'
 ---

+## Gitea
+
+**[Plume on Gitea](https://git.joinplu.me/Plume)**
+
+Gitea is the place where the code lives. The repository for Plume itself is [Plume/Plume](https://git.joinplu.me/Plume).
+The source of the [documentation](https://git.joinplu.me/plume/documentation) and the [official website](https://git.joinplu.me/plume/joinplu.me)
+are also hosted here.
+
+Gitea issues are used to list accepted features that should be implemented, features that need to be discussed, or for bug reports.
+
 ## GitHub

 **[Plume-org on GitHub](https://github.com/Plume-org)**

-GitHub is the place where the code lives. The repository for Plume itself is [Plume-org/Plume](https://github.com/Plume-org/Plume).
-The source of the [documentation](https://github.com/Plume-org/docs) and the [official website](https://github.com/Plume-org/joinplu.me)
-are also hosted here.
+GitHub is used as a mirror of Gitea repositories.

-GitHub issues are used to list accepted features that should be implemented, features that need to be discussed, or for bug reports.
+GitHub issues are also used to list accepted features that should be implemented, features that need to be discussed, or for bug reports.

 ## Crowdin

@ -58,7 +66,7 @@ We publish x86 docker images on Docker Hub. ARM images are hosted by [Lollipop C

 ## Joining one of these places

-We will eventually ask you if you want to be added the GitHib organization, as a Crowdin manager, to the Matrix moderators
+We will eventually ask you if you want to be added the Gitea or GitHib organization, as a Crowdin manager, to the Matrix moderators
 or to the authors of *~PlumeDev@fediverse.blog*.

 If you consider we should add you, you can also ask by yourselve.
--- a/source/update/index.html.md
+++ b/source/update/index.html.md
@ -15,4 +15,4 @@ Please choose the one you are using:
  <li><a href="/update/source-code">From source</a></li>
 </ul>

-Also please check [the release notes](https://github.com/Plume-org/Plume/releases) to see if any additional operation is needed.
+Also please check [the release notes](https://git.joinplu.me/Plume/Plume/releases) to see if any additional operation is needed.
--- a/source/update/prebuilt.html.md
+++ b/source/update/prebuilt.html.md
@ -4,10 +4,9 @@ title: Updating pre-built binaries

 Prebuilt binaries are only available for 64 bits Linux machines.

-You'll need to define these two variables in your shell first:
+You'll need to define a variable in your shell first:

- `PLUME_VERSION`: the Plume version to install. The latest is `0.5.0`.
- `PLUME_DB`: the database backend to use. Either `postgres` or `sqlite`.
+- `DOWNLOAD_URI`: URI of archived binary file. You may find it at https://git.joinplu.me/Plume/Plume/releases. It includes database name `postgresP or `sqlite` in the file name. Choose which you want.

 Then run these commands:

@ -16,7 +15,7 @@ Then run these commands:
 cd Plume

 # Download the files
-wget -O plume.tar.gz https://github.com/Plume-org/Plume/releases/download/$PLUME_VERSION/plume-$PLUME_DB.tar.gz
+wget -O plume.tar.gz $DOWNLOAD_URI
 # Extract them
 tar -xf plume.tar.gz
 mv bin/* ~/.cargo/bin/