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 main branch: git clone [email protected]: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

Redirects

Redirects can be found in ./vercel.json.

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 [email protected]:Macrometacorp/docs.git && cd docs

2. Install dependencies

yarn install

3. Run the docs in developer mode. This mode updates the build whenever you save a change, but it doesn't always make broken links obvious. Docs will be available at http://localhost:3000.

yarn start

4. Before you push a PR, run the production build command. This will create a build and provide an extensive list of any broken links or any other issues that need to be addressed. Make any necessary fixes, then run this command again. Repeat until you do not see any errors in your build.

yarn run build

5. Display the production build. This serves the build you made in the previous step to http://localhost:3000. Unlike the developer mode, this build will not automatically update when you make a change.

yarn run serve

Troubleshooting

If you get a bunch of errors when you do a local build, first try updating your dependencies by running yarn in the top level of the docs directory. You must do this every time dependencies change.

You might also need to update yarn. If you do, follow the instructions displayed in the terminal.