diff --git a/README.md b/README.md index 81bbd0b..53db3f1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ -# frontend-documentation -Graylog frontend documentation and component gallery +# Graylog frontend documentation +Graylog frontend documentation and component gallery. See the live version at: + +[https://graylog2.github.io/frontend-documentation/](https://graylog2.github.io/frontend-documentation/) + +### Run documentation locally +You can run a local version of the documentation from the [graylog2-server](https://github.com/Graylog2/graylog2-server) repository: + +1. Clone [graylog2-server](https://github.com/Graylog2/graylog2-server) +2. Go to the `graylog2-web-interface` folder: + + `cd graylog2-web-interface` +3. Install the web interface requirements +4. Run `yarn install` +5. Run `yarn run docs:server` +6. Go to `http://localhost:6060` on your favourite browser to see the site + +### Contribute +**NOTE** The contents of this repository are auto-generated by [React Styleguidist](https://react-styleguidist.js.org) and you should not edit them by hand. + +You can contribute to the documentation by: +- Editing the markdown files under `https://github.com/Graylog2/graylog2-server/tree/master/graylog2-web-interface/docs` +- Editing the inline JSDoc documentation for components in `https://github.com/Graylog2/graylog2-server/tree/master/graylog2-web-interface/src/components` +- Editing the example markdown files for components in `https://github.com/Graylog2/graylog2-server/tree/master/graylog2-web-interface/src/components` + +Please note that only documentation for components that are more likely to be shared is currently published in the component gallery. Namely, these are the folders we publish: +- `src/components/bootstrap` +- `src/components/common` +- `src/components/configurationforms` +- `src/components/inputs +- `src/components/visualizations` \ No newline at end of file