Forestry.io Interface Overview
Forestry is a CMS interface for static-sites. It is used to provide a user-friendly interface for editing content on the UN SDG National Reporting Initiative website.
Log in to Forestry at https://app.forestry.io/login using the project's credentials.
Note: If you do not have access to the Forestry.io account that has already been set up for this project, creating a new Forestry.io account with access to the website's repository will require a GitHub account with administrative privileges on that repository. Setting up a site with Forestry.io can be found in their official documentation.
Once you have successfully authenticated, you should be redirected to the site menu. Go ahead and select www.sdgreporting.org.
After you have selected a site, you should land on the page directory. If not, you should be able to see the directory of pages under Content > Pages in the navigation sidebar.
Select the _pages directory on the screen to enter the directory. The _pages directory is where the vast majority of the site's page content is stored. Descriptions for each topic are under the _topic directory.
To begin editing, select a page and it should bring up the editor.
On the left side of the editor are Jekyll front matter variables. These should only need to be modified rarely, and only with care, as Jeykll uses these to understand how to construct the page.
On the right side of the editor is the content editing area. You can either write content directly with the rich-text editor, or you can edit transparently with the markup by selecting View source in the upper-right corner.
Important Note: Unfortunately, the templating and markup in the pages cannot easily be completely abstracted away. It is helpful to understand the content in the Jekyll Overview page. Because of this, it is also recommended that you edit content in "View source" mode, as it allows you better insight into how your content should display.
In the rich-text editor, when you select any text, a formatting context menu should appear.
You can generate a preview with the changes you've made by clicking on the preview (eye) icon in the upper-right corner of the editor.
You can discard unsaved changes by selecting the document status indicator above in the editor.
In order to finalize and commit your changes, select the Publish button.
This will commit your changes to GitHub and trigger any automated builds.
-
Important Note: You may have noticed a
Datasection in the sidebar. Please refrain from editing any of these files via Forestry. - Forestry is only meant to allow access to edit content and markup on Jekyll pages.
- Jekyll includes and templates cannot be directly edited through Forestry.
- Styling and scripting cannot be directly edited through Forestry.
- Forestry cannot be used to manage database information.