Github Guide

How to edit the Estate Watch website

To begin editing the Estate Watch website you will first need to be logged in to Github. Next, navigate to the page on the Estate Watch website you want to edit and click the 'edit this page on Github' link at the bottom of the page:

The first time you click on this link, you will be directed to Github and asked if you want to 'fork' the repository.

Click the green 'fork this repository' button and you will then be taken to the page you want to edit.

Note: You will only have to fork the repository once - the first time you make an edit.

Once you have been redirected to the source text page, you will see a page like the one below. Next, click on the pencil icon at the top right of the page to enter editing mode:

Once in editing mode you can edit the text directly or add images and pdf documents, either by dragging and dropping them into the page or copying and pasting them in. You can also use the 'add image' button at the bottom of the page.

This text editor differs from most word processing environments in that it uses 'Markdown' - a lightweight markup language for creating formatted text using a plain-text editor. You can read a short guide on how to use Markdown tags here.

This shows for example, how hyperlinks can be inserted by enclosing the linked word in square brackets followed by the URL in parentheses. The shortcut for this is [CTRL + K] - (hold down the CTRL or CMD key and then press k).

When you have finished editing, you can review what they will look like by clicking on the 'Preview' button. Finally, click the green 'Commit Changes' button and then the 'Propose Changes' and then 'Create pull request' buttons. This will submit your changes for review by an administrator before being published.

In the Github discussions section you will find a general discussion forum as well as some links and suggestions about how to undertake research on the estates.