elof / docs-rn-staging

Official documentation for the Macrometa platform.

Macrometa Docs

Macrometa is a secure, global data platform with integrated pub/sub, stream processing, search, functions, and containers. Create stateful APIs and real-time, event-driven, streaming data apps in minutes – not months.

Explore the Docs 🚀 · Report a Bug 🐛

The Stack

The Macrometa docs are powered by Docusaurus, a static site generator that helps developers ship beautiful, accessible docs. In addition to Docusaurus, we use Stoplight Elements for documenting our REST API and Tailwind for styling.

Contributing

This section describes how you can get make contributions to the Macrometa docs.

Reporting an Issue

Opening an issue is an effective way to contribute because many users might also be impacted. We'll make sure to fix it quickly if it's technically feasible and doesn't have significant side effects for other users.

Before reporting an issue, check that there is not an issue already open for the same topic.

Submitting a Contribution

To make a contribution, you need to:

1. Clone the latest master branch: git clone [e-mail]:Macrometacorp/docs.git
2. Create your feature branch: git checkout -b my-new-contribution
3. Add your changes: git add .
4. Commit your changes: git commit -am "Add a contribution message"
5. Push to the branch: git push -u origin my-new-feature
6. Create a pull request

Pull Requests

All pull requests should have:

• A concise commit message.
• A description of what was changed/added.
• A maintainer will review your pull request and either merge the pull request or request that changes be made before merging.

After you've submitted your pull request:

• Automatic checks will be run
• A team member will review the pull request
• Your contribution will be merged

Building

This section describes how you can get the Macrometa docs up and running on your machine.

Prerequisites

• Node – Using a version manager like nvm or Volta is recommended.
• Yarn – Using the installation instructions here or install with Homebrew.

Installation

1. Clone the repo

git clone [e-mail]:Macrometacorp/docs.git && cd docs

2. Install dependencies

yarn install

3. Run the docs

yarn start

💡 When using the start command, the docs will be available at http://localhost:3000.