Copying and contributing is encouraged!

Contributing

ALL CONTRIBUTIONS MUST BE UNDER THE CC0 LICENSE, IN ORDER TO KEEP THESE RESOURCES IN THE PUBLIC DOMAIN AND AVAILABLE FOR ANYONE

When contributing we assume that you have agreed with your work being public domain.

Short version

Clone this repo, add your changes and send them via git send email to werw0lf [at) riseup {dot] net

Long version

Contributing is really simple. First, clone this repository and cd into it:

git clone https://git.ebin.city/raccoon.git
cd raccoon

Now, you can edit any article or add your own. Take into account that some pages are written in HTML and others in Markdown. If you’ve never used any othem, just write in Markdown, you can learn it by reading a cheatsheet in less than 5 minutes!

As an example, here’s how to add your own guide. Let’s say you’ve just written your fantastic guide and you’ve named it “guide.md”.

Well, then cd into the cloned repository and copy your guide into the corresponding directory:

cd raccoon
mv ~/guide.md guides/guide.md

Now your guide is in the site. But you need to link to it somewhere. Since it’s in the guide sections, the best place to link to it is adding it to the index.md in the guides directory.

Just edit guides/index.md and link to your guide. Done.

Now, commit your changes:

git add .
git commit -m "I added an awesome guide"

You’re almost done! Follow this instructions to send your changes via email to werw0lf [at) riseup {dot] net

The maintainer will read your changes and update the wiki as soon as possible. Keep in mind that this is done by a human and that it may take a while. Thank you.

Thanks for contributing!

Generate the site

This isn’t necessary for contributing, but if you want to set up a mirror or just see how your changes would look like before sending the patch, follow this instructions.

The site is generated with a very simple ssg written in POSIX shell, ssg6. Install it on your system with it’s dependencies: lowdown, grep, find, cpio and a POSIX shell. Then, clone this repo, create a destination directory and run a simple command:

mkdir dst
ssg6 raccoon dst "The Privacy Raccoon" "https://"

Done! The resulting site should be created in the dst directory. If you have any issue, contact us.