KnowHow/FSFELife/EditorialGuidelines

Getting access to the web pages

The source files for the web pages are stored on the [[https://git.fsfe.org/fsfe/fsfe-website|fsfe-website Git repository]], hosted on the FSFE's Git service. Other services are also available on the related Git instance.

To have access to these tools, just follow these instructions:

list and one of our coordinators will be in touch to help you setup an account. More information about volunteer account and the necessary procedures can be found on this dedicated wiki page.

To have write access to the Git repository just write to system-hackers@lists.fsfe.org

Checking out the Git fsfe-website repository

First of all, you should be familiar with our Git. You should already have an account on git.fsfe.org and feel secure with working in a Git repository. For this you can find help on TechDocs/Git and the specific guides First Steps and First Commit.

To download the fsfe-website repository which currently contains the source of fsfe.org, pfdreaders.org and drm.info, you have to clone the Git repository to your computer:

git clone git@git.fsfe.org:FSFE/fsfe-website.git

This command will create the directory fsfe-website in the current working directory of your command line terminal. If you want the local repository to be located somewhere else, create and/or change to another location on your computer.

Working with the repository

Before any change you should update your local copy to fetch the latest changes:

git pull

Now you can make the changes on the files on your computer. To have an overview which files you have edited, you can show the files which differ between your local copy and the latest master:

git status

As soon as you are ready to upload your changes to the website, you have to add your changes to the index. Then you have to commit the files to have them tracked. As the last step, you have to push them to the server.

Let's say you have edited work.en.xhtml and /about/mission.en.xhtml and want to upload these changes to the website. Open a terminal at the root of the fsfe-website copy on your computer and execute carefully:

git status                                      # this will show you the changed files
git add work.en.xhtml /about/mission.en.xhtml   # mark the files for commit
git status                                      # the two files are still visible but are now in the so-called "staging area"
git commit -m "write a short message here what you have changed"

Until here, all changes are still only on your local copy. To upload your modifications to the server, run:

git push

You should now be able to see your pushed commit in the repository's commit log

Read-only access

If you don't have an account on git.fsfe.org and just want to have a copy of the websites' sources on your computer, or if you cannot use the SSH link for any reason, you can also clone via the HTTPS clone link:

git clone https://git.fsfe.org/FSFE/fsfe-website.git

But if you want to edit the website source we encourage you to use the SSH clone link starting with git@git.fsfe.org. Otherwise you will have to type in your Fellowhship account credentials every time you push a change.

The test branch

The Git repository has two main code bases for the FSFE website, the master, which is used to build the production instance of the website at https://fsfe.org/, and the test branch, which is used to build https://test.fsfe.org/.

To work on major changes to the website, including debugging new features that could potentially break the site, you are encouraged to check out the test branch of the Git repository:

git checkout test