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 Sep 12, 2018
1 parent b325197 commit 4905c6b
Show file tree
Hide file tree
Showing 2 changed files with 11 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: Help
read_only: false
- type: directory
path: _articles/reviews
label: For review
Expand Down
26 changes: 11 additions & 15 deletions forestry-help.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---

---
## Creating new articles with Forestry

1. Go to the `For review` section of the sidebar.

1. Click `Add new` on the top of the screen.

1. Choose a front matter template. In most cases, the __basic template__ works perfectly.

1. Add some content to the editor on the right, and click `Save draft`.
2. Click `Add new` on the top of the screen.
3. Choose a Front Matter Template. In most cases, the **basic template** works perfectly.
4. Add some content to the editor on the right, and click `Save draft`.

You can come back and edit the article any time. Please remember that every time you click `Save`, Forestry pushes a commit to GitHub. You can view your file in the DevCenter repository.

Expand All @@ -15,21 +15,17 @@ NOTE: it is recommended to create a new article in an external editor, such as A
## Updating an existing article

1. Create a new article in the `For review` section.

1. Copy the contents of the existing article into the new article.

1. Add your changes.
2. Copy the contents of the existing article into the new article.
3. Add your changes.

NOTE: Once again, it is recommended to edit the existing article in an external editor until it is ready for review. Once you are finished (the article is ready for review), copy the contents into the new article you created in the `For reviews` section. This is to ensure all changes are visible in a single commit.

## Getting an article reviewed

1. Save the article on Forestry - this creates a commit on GitHub so only save on Forestry when your content is ready for review.
2. Go to the [commits page of the DevCenter repository](https://github.com/bitrise-io/devcenter/commits/master) and find the commit or commits created when you saved the article. Its commit message should be "Updated article-name.md" or "Created article-name.md".

1. Go to the [commits page of the DevCenter repository](https://github.com/bitrise-io/devcenter/commits/master) and find the commit or commits created when you saved the article. Its commit message should be "Updated article-name.md" or "Created article-name.md".

NOTE: if you have several articles ready for review, you will find each article in a separate commit.
NOTE: if you have several articles ready for review, you will find each article in a separate commit.

1. Select and copy the links of the commits in your browser's address bar and add them to the review task(s) in ClickUp.

1. Move your writing tasks to _Blocked_ status.
2. Move your writing tasks to _Blocked_ status.

0 comments on commit 4905c6b

Please sign in to comment.