FormidableLabs/victory-docs

Name: victory-docs

Owner: Formidable

Description: Documentation for Victory: A collection of composable React components for building interactive data visualizations

Created: 2016-03-28 22:27:26.0

Updated: 2017-12-31 16:47:24.0

Pushed: 2018-01-18 18:41:13.0

Homepage: http://formidable.com/open-source/victory

Size: 17047

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

victory documentation site

---

Documentation site for victory. victory-docs is running on gatsbyjs.

Getting Started

To install and run the docs site locally:

 install
 run develop 

Then, open your favorite browser to localhost:8000. GraphiQL runs at localhost:8000/___graphql.

Ready to Deploy :shipit:

Build the site to test locally.

 run build

Serve the build.

 run serve

Then, open your favorite browser to localhost:9000 to verify everything looks correct.

If everything checks out, build the production site with the prefixed path, /open-source/victory/, so the files load at the correct URL!

 run build:pp

To publish to NPM run

version <newversion | major | minor | patch> (see Versioning notes below)

Versioning Notes

For a reliable systems of releases, victory-docs should aim for versioning along these lines:

• Patch: Typos, missing assets, broken styles, very minor copyedits.
• Minor: Add a new blog post, change styles.
• Major: Rearchitect how the lander works, remove pages, or something else huge.