Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rserna2010 committed Dec 16, 2014
1 parent 4c542b0 commit 285b6b7
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,24 @@ support](https://github.com/balanced/balanced-api/issues/204).
We try to do as much 'internal' discussion in these issues as well, it's not
just for public feedback. If you want to know what we're thinking, just search
for a relevant issue!


### Edit field descriptions for scenarios

Field descriptions are from balanced.rev1.json, which are generated from
balanced-api. The "forms" used in balanced-docs are assembled from parameters
supplied in the scenarios in balanced-api. Those scenarios should be
updated to include the fields missing the specific scenario section and a
newly generated balanced.rev1.json be committed into the docs. To generate
balanced.rev1.json in balanced-api run:

```bash
bundle exec rake features:all
```
DO NOT run

```bash
bundle exec rake parallel:features
```

doing so causes the file to overwrite itself.

0 comments on commit 285b6b7

Please sign in to comment.