The Fedfree website is maintained in Git, which is a version control system that you can learn more about here: https://git-scm.com/
fedfree project has 2 main Git repositories:
Information about who works on the Fedfree website and who runs the project can be found on who.html
The entire Fedfree website is hosted in a Git repository. Download it like so:
git clone https://notabug.org/fedfree/ffwww
Images are hosted on https://av.fedfree.org/ and available in a separate repository:
git clone https://notabug.org/fedfree/ffwww-img
Make whatever changes you like. See notes below about how to send patches.
Images should be as compressed as possible, but without affecting human-perceived image quality.
To reduce size further, you should also scale and crop the images, showing only what is necessary.
Use common sense. This is to keep the repository from becoming too large. Images are part of a separate repository, specifically so that the main repository can be worked upon more efficiently, because it’s purely plain text.
The entire website is written in Markdown, specifically the Pandoc version of it. The static HTML pages are generated with the Untitled Static Site Generator.
If you like, you can set up a local HTTP server and build your own local version of the website. Please note that images will still link to the ones hosted on https://av.fedfree.org/, so any images that you add to
ffwww-img will not show up on your local
ffwww site if you make the image links (for images that you add) link to
av.fedfree.org. However, it is required that such images be hosted on av.fedfree.org.
Therefore, if you wish to add images to the website, please also submit to the
ffwww-img repository, with the links to them being https://av.fedfree.org/path/to/your/new/image/in/ffwww-img for each one. When it is merged on the fedfree website, your images will appear live.
For development purposes, you might make your images local links first, and then adjust the URLs when you submit your documentation/website patches.
Instructions are on the Untitled website, for how to set up your local version of the website. Download untitled, and inside your
untitled directory, create a directory named
www/ then go inside the www directory, and clone the
ffwww repository there. Configure your local HTTP server accordingly.
Again, instructions are available on the Untitled website for this purpose.
Contributions that you make are publicly recorded, in a Git repository which everyone can access. This includes the name and email address of the contributor.
In Git, for author name and email address, you do not have to use identifying data. You can use
Fedfree Contributor and your email address could be specified as email@example.com. You are permitted to do this, if you wish to maintain privacy. We believe in privacy. If you choose to remain anonymous, we will honour this.
Of course, you can use whichever name and/or email address you like.
Legally speaking, all copyright is automatic under the Berne Convention of international copyright law. It does not matter which name, or indeed whether you even declare a copyright (but we do require that certain copyright licenses are used - read more about that on this same page).
If you use a different name and email address on your commits/patches, then you should be fairly anonymous. Use git log and git show to confirm that before you push changes to a public Git repository.
CC0 preferred, for all contributions, but other libre licenses may be accepted under certain conditions.
See license.html for more information.
Make an account on https://notabug.org/ and navigate (while logged in) to the repository that you wish to work on. Click Fork and in your account, you will have your own repository of Fedfree. Clone your repository, make whatever changes you like to it and then push to your repository, in your account on NotABug. You can also do this on a new branch, if you wish.
In your Notabug account, you can then navigate to the official Fedfree repository and submit a Pull Request. The way it works is similar to other popular web-based Git platforms that people use these days.
You can submit your patches there. Alternative, you can log onto the Fedfree IRC channel and notify the channel of which patches you want reviewed, if you have your own Git repository with the patches.
Once you have issued a Pull Request, the fedfree maintainers will be notified via email. If you do not receive a fast enough response from the project, then you could also notify the project via the
#fedfree channel on Libera IRC.
Markdown file for this page: https://fedfree.org/git.md
This HTML page was generated by the untitled static site generator.