Permalink
Browse files

Blog post typo adjustment and two fixed typos

  • Loading branch information...
1 parent 156faa2 commit bcdfa001ac2cd8c6e87915a006f4ac29474f7b8b @janmoravec janmoravec committed Sep 14, 2012
Showing with 6 additions and 5 deletions.
  1. +6 −5 _posts/2012-09-12-collaborating-through-github.md
@@ -2,11 +2,12 @@
title: Collaborating Through GitHub
excerpt: One of our most popular feature requests is **collaboration among multiple users**. Here's how you can use our GitHub integration to do that
layout: post
+published: false
---
# Collaborating Through GitHub
-One of our most popular [feature requests](https://apiary.uservoice.com/forums/120125-general/suggestions/3003895-share-one-api-among-several-users) is **collaboration among multiple users**. We hear you - but we want to get the collaboration model right - and we're working on it, but it will take time. However, that does not mean you cannot start collaborating with your colleagues on your API design right away. We [launched our GitHub integration](http://blog.apiary.io/2012/05/21/to-our-wonderful-beta-testers/) a couple month back. Here's how to use it to your advantage!
+One of our most popular [feature requests](https://apiary.uservoice.com/forums/120125-general/suggestions/3003895-share-one-api-among-several-users) is **collaboration among multiple users**. We hear you—but we want to get the collaboration model right—and we're working on it, but it will take time. However, that does not mean you cannot start collaborating with your colleagues on your API design right away. We [launched our GitHub integration](http://blog.apiary.io/2012/05/21/to-our-wonderful-beta-testers/) a couple months back. Here's how to use it to your advantage!
1. Go to your [Settings page](https://apiary.io/settings) and connect Apiary to any of your GitHub repositories
2. You can use both public and private repositories, we recommend to use a public one (unless your documentation is hidden from the world):
@@ -15,11 +16,11 @@ 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, 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/versioning.
+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
+> **Note:** From now on, your repository is the source of authorityany changes you make directly in Apiary will be overwritten during your next push to GitHub
-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 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:
sudo gem install apiaryio
<...go to your blueprint directory...>
@@ -47,4 +48,4 @@ One of our most popular [feature requests](https://apiary.uservoice.com/forums/1
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!
+> 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 bcdfa00

Please sign in to comment.