Skip to main content

How to Contribute

This page will help you get set up and provide guidelines for contributing to our documentation.

Prerequisites​

  • Git
  • Node.js (version 12.13.0 or later)
  • Yarn

1. Clone the Repository​

git clone https://github.com/ConductorTechnologies/storm-doc.git
cd storm-doc

2. Install Dependencies​

yarn

3. Run the Site Locally​

Run the site locally to see your changes in real-time. Use the following command to start the development server:

yarn start

This will start the Docusaurus development server and open the site in your default web browser at localhost:3000 (by default). Any changes you make to the documentation will be hot-reloaded.

4. Writing Documentation​

Documentation can be written in Markdown or React JSX. Here's a brief overview of both formats:

Markdown​

Markdown is a lightweight markup language with plain-text formatting syntax. It is easy to read and write. Here’s an example of a simple Markdown file:

# Heading

This is a paragraph with **bold** text and *italic* text.

- Item 1
- Item 2
- Item 3

[Link to another page](./another-page.md)

React JSX​

For more complex components, you can use React JSX. This allows you to include interactive elements. Here’s an example:

import React from 'react';
import { useState } from 'react';

export default function Counter() {
  const [count, setCount] = useState(0);

  return (
    <div>
      <h1>Counter</h1>
      <p>You clicked {count} times</p>
      <button onClick={() => setCount(count + 1)}>Click me</button>
    </div>
  );
}

JSX is especially useful for if you want to render structured JSON data, such as CLI help, API docstrings and so on.

5. Documenting Maya Storm Templates​

If you set up a Storm template in Maya, we have a tool to generate and export node documentation in JSON format, which can then be read into a React component as described above.

6. Pushing Changes and Creating a Pull Request​

Once you've made changes and verified locally, commit to a branch and push your work.

git add .
git commit -m "Description of your changes"
git push origin your-branch-name

Finally, create a pull request. Describe your changes and any relevant information. The documentation will be built as a preview site for review on Vercel.

When your changes are approved, they will be merged into the main branch and deployed to the live site.

Thank you for contributing to this documentation! Your efforts help make our project better for everyone. If you have any questions or need further assistance, feel free to reach out to the maintainers.