Important: To contribute content to the Qumulo Hardware Servicing Guide, use the docs-hardware repository.

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
• Features and Functionality
• Pinned Versions
• Project Infrastructure Overview
• 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

• 🍊 Evan Urubio

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

• ⚡ 🔒 Qontent QuickStart for Engineers

  • 🔒 Qontent Best Practices for Engineers

  • 🔒 To Begin Planning New Feature Documentation

  • 🔒 To Contribute New or Revised Content to the Docs Portal

  • 🔒 To Request Page Migration from Qumulo Care to the Docs Portal

• 🤝 🔒 Working with Team Qontent

• ⚙️ Working with Git and GitHub

  • 🔒 Working with the GitHub Web UI

  • 🔒 Working with the Git CLI

  • 🔒 Useful Git Workflows and Commands

• 📖 Reference

  • 🔒 Acronym and Abbreviation Glossary

  • 🔒 Best Practices for Docs as Code

  • 🔒 Qumulo Style Guide for Tech Docs

  • 🔒 Documentation Runbooks

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 Docs

• 🔧 🔒 Building the REST API and qq CLI Guides

• 📄 🔒 Building PDF Documentation

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.

Features and Functionality

This project began from Jekyll Doc Theme 6.0 by Tom Johnson and received additional custom features and enhancements over time.

• User Experience and Feedback (JS and jQuery)
  • Copy code to clipboard
  • Favorite pages in browser local storage
    • Retrieval of page favorite status
  • Platform Admin Guide switcher
  • Cookie consent banner (adapted from GRT Cookie Consent)
  • Modal pop-up for reporting documentation issues directly into a Jira backlog
  • RAG-driven search with Vectara
    • Custom parametrized URLs with history states
• Layout and navigation (Liquid Templating Language)
  • Breadcrumbs
  • Parent landing pages
  • Child landing pages
• Content creation (Python)
  • Custom generation of REST API documentation from openapi.json with dynamic labeling of REST APIs with versions, PREVIEW, and DEPRECATED tags
  • Custom generation of REST API change summaries from `openapi.json
  • 🔒 Custom generation of qq CLI documentation from the code base

Pinned Versions

• Docs & PDF builds in docs-builder container (docker/build/Dockerfile)
  • Ruby 3.4.1
  • Bundler 4.0.21
  • Jekyll 4.4.1
  • PrinceXML 14.4 (local builds)
• Hot Topic build in google-analytics-script container (tools/hot-topic/Dockerfile)
  • Python 3.11
  • Pip 26.2.1

Project Infrastructure Overview

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.