Qumulo Documentation Portal

Welcome to the Qumulo Documentation Portal repository! This project uses docs-as-code principles to provide guidance about deploying, configuring, and working with cloud and on-premises Qumulo offerings, developer tools and interfaces, and external alerts and monitoring for Qumulo Core.

Table of Contents

• Repository Maintainers
• Contributing to this Project
  • 🍊 As a Qumulon
• Running Tests and Builds
  • 🍊 As a Qumulon
  • How Automation Works in the docs-internal Repository
• About This Project's Infrastructure
• Licenses

Repository Maintainers

The current owner and primary maintainer of this repository is 🍊 Lucía M. Polis.

The secondary maintainers of this repository are:

• 🍊 Andrew Abrahamowicz

• 🍊 Martin Metke

Contributing to this Project

You can contribute content to this repository by sending feedback to this repository's maintainer or by opening a GitHub issue. Before you begin, familiarize yourself with our Contributor Covenant Code of Conduct and Contributing Guidelines.

• Send Feedback

• Open an Issue

🍊 As a Qumulon

• Docs-as-Code Workflows

  • 🔒 Docs as Code Quick-Start Guide for Engineering Teams

  • 🔒 Onboarding to the Docs-as-Code Process at Qumulo

  • 🔒 Best Practices for Working with Docs as Code

• Working with Git and GitHub

  • 🔒 Working with the GitHub Web UI

  • 🔒 Working with the Git CLI

  • 🔒 Useful Git Commands

• Contributing Content

  • 🔒 Preparing Hardware Platform Documentation

  • 🔒 Preparing Release Notes

  • 🔒 Preparing Collateral for a Qumulo Core Release

  • 🔒 Publishing a Qumulo Core Release (Engineering)

  • 🔒 Style Guide for Technical Documentation

    • 🔒 Preparing to Contribute Content

    • 🔒 Structuring a Topic

    • 🔒 Formatting Text and Ordering Information

    • 🔒 Best Practices for Writing and Editing Technical Documentation

Running Tests and Builds

Everything you need to successfully test and build the documentation from the docs-internal repository is located in the dm tool, which you can run from ./tools/docs-menu.sh for the first time.

🍊 As a Qumulon

• 🔒 Building and Checking HTML Documentation

• 🔒 Building the qq CLI and REST API Guides

• 🔒 Building PDF Documentation

• 🔒 Preparing Collateral for a Qumulo Core Release

• 🔒 Publishing a Qumulo Core Release (Engineering)

• 🔒 Documentation Runbooks

How Automation Works in the docs-internal Repository

• Testing: This repository runs the .github/workflows/test.yml workflow on every commit to the docs-internal repository.

• Publishing: When the repository owner merges a pull request to mainline, the docs-internal repository runs the .github/workflows/publish.yml workflow.

About this Project's Infrastructure

The following diagram outlines the most current project infrastructure.

Licenses

This project uses the Creative Commons Attribution 4.0 International overall and the BSD 3-Clause License for the Navgoco jQuery component.

All content is Copyright © Qumulo, Inc. except where specified otherwise.