CONTRIBUTING.md 4.88 KB
Newer Older
chairmantheboring's avatar
chairmantheboring committed
1
# Contributing to ReverseEagle Developers
TheMainOne's avatar
TheMainOne committed
2

chairmantheboring's avatar
chairmantheboring committed
3
## Writing a page from scratch
TheMainOne's avatar
TheMainOne committed
4

chairmantheboring's avatar
chairmantheboring committed
5 6 7 8 9 10 11
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:
TheMainOne's avatar
TheMainOne committed
12 13 14 15 16 17 18 19 20

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

chairmantheboring's avatar
chairmantheboring committed
21
Now, you have to describe the tool being replaced, keeping the example above, Google Docs:
TheMainOne's avatar
TheMainOne committed
22 23 24 25 26 27 28

```md
# Google Docs

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

chairmantheboring's avatar
chairmantheboring committed
29
After describing the tool being replaced, you need to include an alternative, for example, Etherpad:
TheMainOne's avatar
TheMainOne committed
30 31 32 33 34 35 36

```md
## Etherpad

An open source alternative to Google Docs.
```

chairmantheboring's avatar
chairmantheboring committed
37
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:
TheMainOne's avatar
TheMainOne committed
38 39 40 41 42 43 44 45 46

```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 %}
```
chairmantheboring's avatar
chairmantheboring committed
47 48

After you've finished, your markdown file should look like this:
TheMainOne's avatar
TheMainOne committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71

```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 %}
```
chairmantheboring's avatar
chairmantheboring committed
72 73

After you're finished writing your infoboxes, `git commit` your changes, add a descriptive commit message.
TheMainOne's avatar
TheMainOne committed
74
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).
chairmantheboring's avatar
chairmantheboring committed
75 76 77 78 79 80


## 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.
TheMainOne's avatar
TheMainOne committed
81
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`".
chairmantheboring's avatar
chairmantheboring committed
82

TheMainOne's avatar
TheMainOne committed
83 84 85 86 87 88 89 90 91 92 93 94
```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 %}
```
chairmantheboring's avatar
chairmantheboring committed
95 96

Once you're done, it should look something like this:
TheMainOne's avatar
TheMainOne committed
97 98 99 100 101 102 103 104 105 106 107 108

```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 %}
109 110 111 112 113 114 115 116 117 118 119

## 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 %}
TheMainOne's avatar
TheMainOne committed
120
```
chairmantheboring's avatar
chairmantheboring committed
121 122

After you're finished writing your infoboxes, `git commit` your changes, add a descriptive commit message.
TheMainOne's avatar
TheMainOne committed
123
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).