Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/e0ipso/apiary-integration-test
This repo integrates with apiary.io (Sample API v2)
https://github.com/e0ipso/apiary-integration-test
Last synced: about 2 months ago
JSON representation
This repo integrates with apiary.io (Sample API v2)
- Host: GitHub
- URL: https://github.com/e0ipso/apiary-integration-test
- Owner: e0ipso
- License: gpl-2.0
- Created: 2014-09-08T13:46:26.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-09-08T15:59:35.000Z (over 10 years ago)
- Last Synced: 2024-10-12T02:27:06.191Z (3 months ago)
- Size: 168 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Apiary collaboration workflow.
In order to maintain a workflow that will keep the documentation centralized and notifies everyone about the most recent changes to it here is a proposed workflow:
## Setting up the environment.
### Initial setup.
1. The repository owner and the apiary.io account owner should connect both accounts according to [this post](http://blog.apiary.io/2012/10/08/collaborating-through-github/).
1. First of all clone the documentation repo in you local. This will allow you to get the API documentation file called `apiary.apib`.
1. Install the `apiary` command line gem as described in [this article](https://github.com/apiaryio/apiary-client#install).
### Documentation updates workflow.
1. Every time that you need to make an update of the docs modify `apiary.apib` in your local.
1. Preview the documentation locally by running:
```shell
apiary preview
```
1. Submit a pull request to the documentation repository.
1. After the PR has been peer reviewed and has the green light of at least one more peer, **close** the PR without merging it and run:
```shell
apiary publish --api-name [API-NAME] --message '[CHANGE-MESSAGE]'
```
This will update the documentation in the apiary.io servers (updating the mock servers and the provided documentation) and it will create a commit with the changes in the master branch of the documentation repository.
## Making sure everyone is on the same page.
In order to get notified about the changes made by any peer you should use a mailing list. In order to configure that go to the repository settings and set up the mailing list address after adding the *Email* service.
This will allow non-github users to get notifications. Whenever there is a commit / PR in the repository the mailing list will be notified. For instance:
