Skip to content

Commit

Permalink
doc: add doc build instructions, update PR/issue templates with doc l…
Browse files Browse the repository at this point in the history
…inks
  • Loading branch information
epicfaace committed Jan 21, 2019
1 parent bc15e23 commit 9fdab86
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
5 changes: 2 additions & 3 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
### Prerequisites

- [ ] I have read the [documentation](https://github.com/mozilla-services/react-jsonschema-form/blob/master/README.md#readme);
- [ ] I have read the [documentation](https://react-jsonschema-form.readthedocs.io/);
- [ ] In the case of a bug report, I understand that providing a [SSCCE](http://sscce.org/) example is tremendously useful to the maintainers.
- [ ] Ideally, I'm providing a [sample JSFiddle](https://jsfiddle.net/n1k0/f2y3fq7L/6/) or a [shared playground link](https://mozilla-services.github.io/react-jsonschema-form/) demonstrating the issue.

### Description

Expand All @@ -13,8 +14,6 @@
2. [Second Step]
3. [and so on...]

Ideally, I'm providing a [sample JSFiddle](https://jsfiddle.net/n1k0/f2y3fq7L/6/) or a [shared playground link](https://mozilla-services.github.io/react-jsonschema-form/) demonstrating the issue.

#### Expected behavior

[What you expected to happen]
Expand Down
5 changes: 2 additions & 3 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ If this is related to existing tickets, include links to them as well.
### Checklist

* [ ] **I'm updating documentation**
- [ ] I've checked the rendering of the Markdown text I've added
- [ ] If I'm adding a new section, I've updated the Table of Content
- [ ] I've [checked the rendering](https://react-jsonschema-form.readthedocs.io/en/latest/#contributing) of the Markdown text I've added
* [ ] **I'm adding or updating code**
- [ ] I've added and/or updated tests
- [ ] I've updated docs if needed
- [ ] I've updated [docs](https://react-jsonschema-form.readthedocs.io/) if needed
- [ ] I've run `npm run cs-format` on my branch to conform my code to [prettier](https://github.com/prettier/prettier) coding style
* [ ] **I'm adding a new feature**
- [ ] I've updated the playground with an example use of the feature
10 changes: 10 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,16 @@ If you want the development server to listen on another host or port, you can us
$ RJSF_DEV_SERVER=0.0.0.0:8000 npm start
```

### Build documentation

We use [mkdocs](https://www.mkdocs.org/) to build our documentation. To run documentation locally, run:
```
$ pip install mkdocs==1.0.4
$ mkdocs serve
```

Documentation will be served by [localhost:8000](http://localhost:8000).

### Tests

```
Expand Down

0 comments on commit 9fdab86

Please sign in to comment.