Permalink
Browse files

Updated for github 2way sync

  • Loading branch information...
1 parent 2ef4a67 commit 3fe5ab7e7afa1fcaa77a5838d42ce3ce6b429161 @zzen zzen committed Oct 8, 2012
Showing with 5 additions and 8 deletions.
  1. +5 −8 _posts/2012-10-08-collaborating-through-github.md
View
13 _posts/2012-10-08-collaborating-through-github.md
@@ -15,21 +15,19 @@ One of our most popular [feature requests](https://apiary.uservoice.com/forums/1
3. Once you connect your GitHub repo, we automatically synchronize your API Blueprint into GitHub.
4. You can now edit the blueprint on your local computer and push it into GitHub—and your documentation changes instantly. We receive webhooks from GitHub and scan for changes to the API Blueprint.
-5. You can cooperatively edit with everybody, and let Git take care of the merging and versioning.
-
-> **Note:** From now on, your repository is the source of authority—any changes you make directly in Apiary will be overwritten during your next push to GitHub
+5. You can cooperatively edit with everybody, and let Git take care of the merging and versioning. If you edit a file in Apiary, it will ask for a commit message and push to GitHub. If you edit a file on your computer and push to GitHub, we will pick up the changes automatically.
-6. To simplify the edit-preview-commit-push cycle of the git workflow, we've created an [Apiary Ruby Gem](https://github.com/apiaryio/apiary-client) to help you preview the documentation before pushing to GitHub. Just run:
+6. To simplify the workflow on your local computer (edit-preview-commit-push), we've created an [Apiary Ruby Gem](https://github.com/apiaryio/apiary-client) to help you preview the documentation before pushing to GitHub. Just run:
sudo gem install apiaryio
<...go to your blueprint directory...>
apiary preview
<...generates and previews your documentation...>
-
+
You can also just run `--help` to get a list of all commands:
-
+
$ apiary --help
-
+
Usage: apiary command [options]
Try 'apiary help' for more information.
@@ -45,6 +43,5 @@ One of our most popular [feature requests](https://apiary.uservoice.com/forums/1
help Show help
version Show version
-
> We're also working on syntax highlighting for your editor&mdash;[let us know](mailto:support@apiary.io) which editor you're using!

0 comments on commit 3fe5ab7

Please sign in to comment.