Skip to content

Files

Latest commit

author
Edmundo Alvarez
Jan 12, 2018
7e921f4 · Jan 12, 2018

History

History
31 lines (24 loc) · 1.92 KB

README.md

File metadata and controls

31 lines (24 loc) · 1.92 KB

Graylog frontend documentation

Graylog frontend documentation and component gallery. See the live version at:

https://graylog2.github.io/frontend-documentation/

Run documentation locally

You can run a local version of the documentation from the graylog2-server repository:

  1. Clone 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 and you should not edit them by hand.

You can contribute to the documentation by:

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