Steampipe Docs

The Steampipe Documentation is open source! You can give us feedback and request for changes by submitting issues and pull requests in this repository.

Format & Structure

Docs are written in markdown format and are located in docs folder. The entry-point document will contain front-matter with slug: /.

Each document requires the following frontmatter, adjust the values as per your requirement:

id: learn
title: Learn Steampipe
sidebar_label: Learn Steampipe

We support up to 2 levels of docs, e.g.:

docs/foo
docs/foo/bar

For your docs to appear in the sidebar, you need to edit docs/sidebar.json. This is an array of sidebar entries, which are either stings matching the path of the required document, or a category to nest the docs down 1 level.

Any images required by docs must be placed in /images/docs/... and must be referenced by the tag <img src="/images/docs/..." />.

Guidelines for contribution

Thank you for your interest in contributing to Steampipe documentation! We greatly value feedback and contributions from our community.

Please read through this document before you submit any pull requests or issues. It will help us to collaborate more effectively.

What to expect when you contribute

When you submit a pull request, our team is notified and will respond as quickly as we can. We'll do our best to work with you to ensure that your pull request adheres to our style and standards.

We look forward to receiving your pull requests for:

Inaccuracies in the content
Information gaps in the content that need more detail to be complete
Grammatical errors or typos
Suggested rewrites that improve clarity and reduce confusion

How to contribute

To contribute, send us a pull request.

Fork the repository.
In your fork, make your change in a branch that's based on this repo's main branch.
Commit the change to your fork, using a clear and descriptive commit message.
Create a pull request

Before you send us a pull request, please be sure that:

You're working from the latest source on the main branch.
You check existing open pull requests to be sure that someone else hasn't already addressed the problem.
You create an issue before working on a contribution that will take a significant amount of your time.

For contributions that will take a significant amount of time, open a new issue to pitch your idea before you get started. Explain the problem and describe the content you want to see added to the documentation. We don't want you to spend a lot of time on a contribution that might be outside the scope of the documentation or that's already in progress.

Finding contributions to work on

If you'd like to contribute, but don't have a project in mind, look at the open issues in this repository for some ideas.