Contribute to Deflect documentation

This website aims to share collected experience and provide directions to Deflect users and to sys admins who wish to install their own Deflect instances on their server.

It is a work in progress and we welcome contributions. Please, read this guide to learn how to contribute to this website.

If you wish to translate this website into a different language, read these instructions.

How to contribute

The Deflect documentation website is generated automatically from a repository hosted on Github. The Sphinx documentation tool is used to convert the text files to HTML.

All text files are formatted in reStructuredText, a lightweight markup language that you can use to format the text. The syntax of reStructuredText is easy to use and you can find the references you need here.

To contribute to Deflect documentation, the first thing you need to do is to create a GitHub account.

Once you have created an account, you can:

  • Edit the repository in your own branch and submit a pull request..
  • Become a member of the project and edit the master repository directly. In this case all your edits will be deployed to the website within few minutes.

Add or edit files

Add a new file or directory

To add a new file or directory to the project, go to the master repository and select one of the following option from the top bar:

  • Create new file - By selecting this option, you will be able to add a new file by editing it in the web interface. It should be saved with the .rst extension.
  • Upload files - This option allows you to upload a file that you have already created in your local computer. This is the option you need to select, for example, if you want to add images or PDF files. Images should be uploaded to the img/ directory.

Edit files

To edit an existing file, just select it in the file list to view the text and then click on the “Edit” pen icon in the right-top corner. An editing interface will open where you can change both the title of the file and the text.

When you’re done, click on the “Commit changes” button in the bottom left corner of the window.

Add or edit files by command line

If you know how to use git from a command line, you can just clone the repository to your local computer and then commit your changes by submitting a pull request or by pushing directly your changes to the master repository if you’re a member of the project.

Contribute directly to the documentation

If you are sure of what you are doing and wish to contribute directly to the documentation, you can ask us to become a member of the documentation project. Please write to us at deflect @ equalit . ie to explain who you are and what you would like to contribute with.

Once we have accepted your access request, you will be able to edit the repository directly, and all your changes will be deployed to the Deflect documentation website within a few minutes.

Important notes

reStructuredText

All text files of Deflect’s documentation are written in reStructuredText. Please read the basics of reStructuredText before you start contributing to this project.