Rubix Docs

Contributing to the Rubix Docs

We welcome contributions to our Rubix Docs! This guide will walk you through the steps to update and add content to the site.

Prerequisites

To contribute to the Rubix Docs, you will need the following:

• A GitHub account
• Write access to the repository containing the site
• A local installation of Git
• A text editor

Updating Content

To edit the content on the site:

1. Clone the repository to your local machine using Git:

  git clone https://github.com/NubeIO/rubix-ce-docs.git

2. Make changes to the relevant Markdown files in your text editor.

3. Commit your changes to your local Git repository:

  git add .
  git commit -m "Update site content Rubix Docs"

4. Push your changes to the remote repository:

  git push

editing the home page

https://github.com/NubeIO/rubix-ce-docs/blob/main/src/pages/index.tsx#L15

https://github.com/NubeIO/rubix-ce-docs/blob/main/src/components/HomepageFeatures/index.tsx#L14

To test your changes before submitting a pull request:

5. Run the site locally:

  yarn install
  yarn start

6. Open a web browser and go to http://localhost:3000/ to view the site with your changes.

Submitting a Pull Request

Once you have tested your changes and are happy with them, you can submit a pull request:

1. Go to the GitHub repository and click the Pull Requests tab.
2. Click the New pull request button.
3. The branch you want to merge into main branch.
4. Click the Create pull request button.
5. Add a title and description for your pull request, and click the Create pull request button.
6. merge PR (wait for the github actions to finish before deleting the branch)

Conclusion

Congratulations, you have contributed to the Rubix Docs! Thank you for your contribution.