CONTRIBUTING.md

# Contributing to ReverseEagle Developers

## Writing a page from scratch

You've looked at developers.reverseeagle.org and have decided that we are missing alternatives to proprietary software you use. You've come to the right place. Here we describe how to write a page from scratch.

First, let's start off with the naming conventions. We use the service's name as the name of the markdown file. If you were planning to replace Google Docs, the file name would be "google-docs.md"

To start, you'll have to fork the [ReverseEagle Developers Git Repo](https://forge.tedomum.net/ReverseEagle/developers). After you've done that, clone it to your PC.

When writing a new page, you have to include these lines:

```md
---
product: Google Docs
type: "Online Collaborative Text Editor"
layout: replace
---
```

Now, you have to describe the tool being replaced, keeping the example above, Google Docs:

```md
# Google Docs

Google Docs, an online collaborative text editor.
```

After describing the tool being replaced, you need to include an alternative, for example, Etherpad:

```md
## Etherpad

An open source alternative to Google Docs.
```

Now you have to write the infobox for your replacement tool, in our example, we used Etherpad, so here is an example of an infobox for Etherpad:

```md
{% infobox %}
- **Website**: [Etherpad.org](https://etherpad.org/)
- **Source Code**: [GitHub](https://github.com/ether/etherpad-lite/)
- **License**: [APACHE V2](https://github.com/ether/etherpad-lite/blob/develop/LICENSE)
- **Instance List**: [GitHub Wiki Page](https://github.com/ether/etherpad-lite/wiki/Sites-that-run-Etherpad-Lite)
{% endinfobox %}
```

After you've finished, your markdown file should look like this:

```md
---
product: Google Docs
type: "Online Collaborative Text Editor"
layout: replace
---

# Google Docs

Google Docs, an online collaborative text editor.

## Etherpad

An open source alternative to Google Docs.

{% infobox %}
- **Website**: [Etherpad.org](https://etherpad.org/)
- **Source Code**: [GitHub](https://github.com/ether/etherpad-lite/)
- **License**: [APACHE V2](https://github.com/ether/etherpad-lite/blob/develop/LICENSE)
- **Instance List**: [GitHub Wiki Page](https://github.com/ether/etherpad-lite/wiki/Sites-that-run-Etherpad-Lite)
{% endinfobox %}
```

After you're finished writing your infoboxes, `git commit` your changes, add a descriptive commit message.
Once you've done that, `git push` your changes, wait a minute or two, then add a merge request to the [ReverseEagle Developers Git repository here](https://forge.tedomum.net/ReverseEagle/developers/-/merge_requests).


## Adding another alternative to a piece of software that already has a page
Sometimes, you don't have to write everything from scratch. You just want to add an alternative to a piece of software. Using our example above, we can do that.

To add an example, you just have to describe your software and write an infobox. For this example, we'll be adding an alternative to Google Docs, named Cryptpad.
To get started, you have to fork the [ReverseEagle Developers Git repository](https://forge.tedomum.net/ReverseEagle/developers), then clone it to your computer. Navigate to the "`replace`" folder in the new folder on your computer, then add your changes to the product you wish to replace, in this case, "`Google-Docs.md`".

```md
## Cryptpad

An end-to-end encrypted, zero-knowledge, collaborative document editor.

{% infobox %}
- **Website**: [Cryptpad.fr](https://cryptpad.fr)
- **Source code**: [Github](https://github.com/xwiki-labs/cryptpad/)
- **License**: [AGPLv3](https://github.com/xwiki-labs/cryptpad/blob/main/LICENSE)
- **Instance list**: [GitHub Wiki Page](https://github.com/xwiki-labs/cryptpad/wiki/Public-instances)
{% endinfobox %}
```

Once you're done, it should look something like this:

```md
## Cryptpad

An end-to-end encrypted, zero-knowledge, collaborative document editor.

{% infobox %}
- **Website**: [Cryptpad.fr](https://cryptpad.fr)
- **Source code**: [Github](https://github.com/xwiki-labs/cryptpad/)
- **License**: [AGPLv3](https://github.com/xwiki-labs/cryptpad/blob/main/LICENSE)
- **Instance list**: [GitHub Wiki Page](https://github.com/xwiki-labs/cryptpad/wiki/Public-instances)
{% endinfobox %}

## Etherpad

An open source alternative to Google Docs.

{% infobox %}
- **Website**: [Etherpad.org](https://etherpad.org/)
- **Source Code**: [GitHub](https://github.com/ether/etherpad-lite/)
- **License**: [APACHE V2](https://github.com/ether/etherpad-lite/blob/develop/LICENSE)
- **Instance List**: [GitHub Wiki Page](https://github.com/ether/etherpad-lite/wiki/Sites-that-run-Etherpad-Lite)
{% endinfobox %}
```

After you're finished writing your infoboxes, `git commit` your changes, add a descriptive commit message.
Once you've done that, `git push` your changes, wait a minute or two, then add a merge request to the [ReverseEagle Developers Git Repo here](https://forge.tedomum.net/ReverseEagle/developers/-/merge_requests).