Skip to content

Commit

Permalink
Update from Forestry.io - Updated forestry-help.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zoltan-baba authored and Forestry.io committed Nov 28, 2018
1 parent 33937ee commit fca3892
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 16 deletions.
1 change: 0 additions & 1 deletion .forestry/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ sections:
- type: document
path: forestry-help.md
label: Forestry User Guide
read_only: false
- type: directory
path: _articles/reviews
label: For review
Expand Down
43 changes: 28 additions & 15 deletions forestry-help.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---

---
---
***

---
**IMPORTANT: This guide is intended to be used with the Forestry CMS**. Our external contributors who submit pull requests to the DevCenter repository do NOT need to follow this guide as it is not relevant for them!
***

**IMPORTANT: This guide is intended to be used with the Forestry CMS**. Our external contributors who submit pull requests to the DevCenter repository do NOT need to follow this guide as it is not relevant for them!

***

Expand All @@ -20,7 +21,7 @@ You can come back and edit the article any time. Please remember that every time
**IMPORTANT:** Please make sure when your article is ready for review that a single commit on GitHub makes all changes visible. With a new article, that means you should:

1. Cut its entire content (keep it on the clipboard!) and then click `Save draft`
2. Once it is saved (the little circle is green), paste the content back in and click `Save draft`.
2. Once it is saved (the little circle is green), paste the content back in and click `Save draft`.

This way you will have a commit that will show the entire content of the article as new content. Voilá!

Expand All @@ -30,7 +31,7 @@ This way you will have a commit that will show the entire content of the article
2. Copy the contents of the existing article into the new article.
3. Add your changes.

**IMPORTANT:** Please make sure when your article is ready for review that a single commit on GitHub makes all changes visible. With an existing article this means you should make sure that all your changes are added with a single `Save`.
**IMPORTANT:** Please make sure when your article is ready for review that a single commit on GitHub makes all changes visible. With an existing article this means you should make sure that all your changes are added with a single `Save`.

### Getting an article reviewed

Expand All @@ -47,20 +48,32 @@ NOTE: if you have several articles ready for review, you will find each article
Once the review is done and the article is approved, we are ready to publish.

1. Copy the contents of the article in the `For review` section in to the article in its "proper" place. For example, if you edited the _Quick Start Guide to Bitrise_ article, copy the content from the article in the `For review` section to the article in the `Getting started` section.
2. If the `Draft` setting is `ON`, turn it off. Once it's off, click `Save`.

And done! Forestry will push your article into the repository and GitHub pages will build it.
2. If the `Draft` setting is `ON`, turn it off. Once it's off, click `Save`.

### Images and links
And done! Forestry will push your article into the repository and GitHub pages will build it.

### Note, info, warning
### Note, info, warning

Forestry supports using snippets to quickly add shortcodes to your content. In our case, the snippets include all message boxes which are HTML codes inserted directly into the content, parsed when building the site.
Forestry supports using snippets to quickly add shortcodes to your content. In our case, the snippets include all message boxes which are HTML codes inserted directly into the content, parsed when building the site.

NOTE: You can only insert snippets from the WYSIWYG editor.
NOTE: You can only insert snippets from the WYSIWYG editor.

1. Place the cursor where you wish to insert a message box.
1. Place the cursor where you wish to insert a message box.
2. Open the Snippets menu on the bottom toolbar.
3. Select the type of message box you need.
3. Select the type of message box you need.
4. Enter the title of your message between the quotation marks after `title=.`
5. Enter the content of your message between the quotation marks after `content=`.
5. Enter the content of your message between the quotation marks after `content=`.

### Tips and tricks

#### The {% raw %} tag

Jekyll is built on the Liquid templating language and therefore tries to parse anything within double curly brackets {{ such as this }}. The result is the content within simply will not appear once the site is built.

The workaround is to use the {% raw %} tag to indicate to Jekyll that nothing within the tag needs to be parsed. Like this:

{% raw %}

Please, {{ Jekyll }}, just display everything, brackets and all here.

{% endraw %}

0 comments on commit fca3892

Please sign in to comment.