-
Notifications
You must be signed in to change notification settings - Fork 0
Editing the Website
Editing the project's website is slightly more tricky than editing the landing blurb. Different headers and functionalities require slightly different steps, so lets break them down step-by-step.
-
To edit the website, you will need to have a personal account which is a member of this organisational account. Contact crahal or DiarmuidM to be added to this account accordingly.
-
All of the changes need to be made in the uk-third-sector-database.github.io repository within this account.
- To edit the 'profile picture'/logo of the site, you need to add a new image into the images subdirectory.
- In the config.yml file, change the filename which pertains to line ~84: "avatar" (e.g. replace "charity-data-logo.png" with the filename of the file which you uploaded in step 1.
- Simply edit other fields of the config.yml as appropriate. Noteable things which we might want to edit include the 'name', 'bio', 'twitter', etc.
Editing pages which are relatively static -- i.e. ones that dont get updated with regular blog posts -- is fairly simple and consistent across three of the main tabs at the top of the header. That is, for the 'about' landing page, the 'Meet the Team' page, and the 'Data' page.
- Navigate to the [_pages](uk-third-sector-database.github.io subdirectory in the uk-third-sector-database.github.io repository.
- Then, find the about.md, meet-the-team.md and data.md files respectively.
- To edit these individual pages, simply click into the files and then click the pencil icon.
- Make any changes as you think appropriate, and then 'committ' your changes at the bottom of the page, leaving a comment on the committ as appropriate.
Three of the headers at the top of the page relate to things which can be dynamically updated, one by one. These are publications, talks and posts. Editing these pages to add new talks, publications, and posts is slightly more complicated:
- Copy and paste data from an existing, talk, publication or post into a new text file.
- Make edits to this new file as appropriate to reflect the new entry which you are seeking to add to the website.
- Add this to the subdirectory at the appropriate place, calling the new file something akin to "2022-12-05-paper-title-number-1.md" or "2022-12-05-blog-post-1.md"
- It is essential that you i.) do not delete the existing files this repository, and that you rename your the new file with a '.md' extension.
- The website will now index these new additions to each of these three types of pages dynamically, and display them at the appropriate part of the website.
Editing the header of the website (e.g. the 'Blog Posts', 'Talks', 'Data', 'Publications' and 'Meet the Team' at the top) is slightly more difficult.
- To do this, you need to edit the navigation.yml file in the _data subdirectory.
- Add or remove title and url combinations as appropriate.
- Note that
uk-third-sector-database.github.io/_datais not the place to edit the information about the database constructed by the project. This is a repository which hosts meta-data\configuration data about the site. To change information on the 'Data' page of the site, be sure to navigate to_pages/dataas discussed above. - Be sure to set up the corresponding pages (either static or dynamic as described above) when editing
navigation.yml, or this will otherwise lead to the site's 404.md error page.