DocOps Lab Contributor Documentation
Comprehensive guides and reference materials for using and contributing to DocOps Lab projects.
|
Note
DocOps Lab Product Documentation is indexed at https://docopslab.org/docs/products.
|
Policy
DocOps Lab Contributor’s Guide
Guidelines, protocols, and best practices for contributing to DocOps Lab projects.
DocOps Lab Privacy Assurances
No telemetry, no data collection, period.
DocOps Lab Generative “AI” Guidance
How we manage output that was created with at least partial assistance from an LLM/agent
Procedure
Development Process (General)
General development process for DocOps Lab projects
Dev-tooling Setup
Environment and Bootstrapping for new DocOpsLab project codebases or establishing a complete dev environment
Dev-tooling Usage
Using docopslab-dev tooling with DocOps Lab project codebases
Product Change Tracking and Documentation
Integration and deployment/delivery process for DocOps Lab sites and artifacts.
Release Process (General)
Integration and deployment/delivery process for DocOps Lab sites and artifacts.
Deployment Setup (General)
Initial preparation for publishing gems, Docker images, and documentation sites
Using GitHub Issues
Tracking work for DocOps Lab projects
Reference
Dev-tooling Configuration
Configuring the `docopslab-dev.yml` manifest for DocOps Lab development tooling
Development & Deployment Infrastructure
Local and cloud assets for DocOps Lab projects
Specs & Tests
Specifying and testing DocOps Lab projects
GitHub Issues Types and Tasks
Tracking work for DocOps Lab projects
Ruby Development Style Guide
Ruby coding styles and conventions for DocOps Lab projects.
Documentation Style Guide
DocOps Lab documentation style guide and AsciiDoc syntax conventions.
Code Commenting Guidance
Protocols and styles for commenting code in DocOps Lab projects.
Dockerfile and Docker Image Management
Dockerfile coding and Docker image management in DocOps Lab projects
Git Commits Style Guide
Protocols for authoring Git commits for DocOps Lab projects
Bash Scripting Styles and Conventions
Style guide and best practices for writing Bash scripts in DocOps Lab projects
Command-line Interface Styles
Style guide and best practices for writing Ruby and Bash CLI utilities
Troubleshooter
Fix Broken Links
Troubleshooting and fixing broken links in DocOps Lab documentation sites.
Fix Jekyll-AsciiDoc Build Errors
Analyzing and addressing Asciidoctor errors that surface in Jekyll build operations
Fix Spelling Issues
Troubleshooting and fixing spelling issues with optional AI support.
Template
AGENTS.md Template
AI Agent Guide orientation template for DocOps Lab projects
Universal Project Attributes
Current status of all project info as AsciiDoc attributes
Contributing
DocOps Lab Contributor’s Guide
Guidelines, protocols, and best practices for contributing to DocOps Lab projects.
Technical
Development Process (General)
General development process for DocOps Lab projects
Dev-tooling Setup
Environment and Bootstrapping for new DocOpsLab project codebases or establishing a complete dev environment
Dev-tooling Configuration
Configuring the `docopslab-dev.yml` manifest for DocOps Lab development tooling
Dev-tooling Usage
Using docopslab-dev tooling with DocOps Lab project codebases
Product Change Tracking and Documentation
Integration and deployment/delivery process for DocOps Lab sites and artifacts.
Release Process (General)
Integration and deployment/delivery process for DocOps Lab sites and artifacts.
Deployment Setup (General)
Initial preparation for publishing gems, Docker images, and documentation sites
Fix Broken Links
Troubleshooting and fixing broken links in DocOps Lab documentation sites.
Fix Jekyll-AsciiDoc Build Errors
Analyzing and addressing Asciidoctor errors that surface in Jekyll build operations
Fix Spelling Issues
Troubleshooting and fixing spelling issues with optional AI support.
Development & Deployment Infrastructure
Local and cloud assets for DocOps Lab projects
Specs & Tests
Specifying and testing DocOps Lab projects
Using GitHub Issues
Tracking work for DocOps Lab projects
GitHub Issues Types and Tasks
Tracking work for DocOps Lab projects
Ruby Development Style Guide
Ruby coding styles and conventions for DocOps Lab projects.
Documentation Style Guide
DocOps Lab documentation style guide and AsciiDoc syntax conventions.
Code Commenting Guidance
Protocols and styles for commenting code in DocOps Lab projects.
Dockerfile and Docker Image Management
Dockerfile coding and Docker image management in DocOps Lab projects
Git Commits Style Guide
Protocols for authoring Git commits for DocOps Lab projects
Bash Scripting Styles and Conventions
Style guide and best practices for writing Bash scripts in DocOps Lab projects
Command-line Interface Styles
Style guide and best practices for writing Ruby and Bash CLI utilities
AGENTS.md Template
AI Agent Guide orientation template for DocOps Lab projects
Universal Project Attributes
Current status of all project info as AsciiDoc attributes
Legal
DocOps Lab Privacy Assurances
No telemetry, no data collection, period.
DocOps Lab Generative “AI” Guidance
How we manage output that was created with at least partial assistance from an LLM/agent
AGENTS.md Template
AI Agent Guide orientation template for DocOps Lab projects
Bash Scripting Styles and Conventions
Style guide and best practices for writing Bash scripts in DocOps Lab projects
Code Commenting Guidance
Protocols and styles for commenting code in DocOps Lab projects.
Command-line Interface Styles
Style guide and best practices for writing Ruby and Bash CLI utilities
Deployment Setup (General)
Initial preparation for publishing gems, Docker images, and documentation sites
Dev-tooling Configuration
Configuring the `docopslab-dev.yml` manifest for DocOps Lab development tooling
Dev-tooling Setup
Environment and Bootstrapping for new DocOpsLab project codebases or establishing a complete dev environment
Dev-tooling Usage
Using docopslab-dev tooling with DocOps Lab project codebases
Development & Deployment Infrastructure
Local and cloud assets for DocOps Lab projects
Development Process (General)
General development process for DocOps Lab projects
DocOps Lab Contributor’s Guide
Guidelines, protocols, and best practices for contributing to DocOps Lab projects.
DocOps Lab Generative “AI” Guidance
How we manage output that was created with at least partial assistance from an LLM/agent
DocOps Lab Privacy Assurances
No telemetry, no data collection, period.
Dockerfile and Docker Image Management
Dockerfile coding and Docker image management in DocOps Lab projects
Documentation Style Guide
DocOps Lab documentation style guide and AsciiDoc syntax conventions.
Fix Broken Links
Troubleshooting and fixing broken links in DocOps Lab documentation sites.
Fix Jekyll-AsciiDoc Build Errors
Analyzing and addressing Asciidoctor errors that surface in Jekyll build operations
Fix Spelling Issues
Troubleshooting and fixing spelling issues with optional AI support.
Git Commits Style Guide
Protocols for authoring Git commits for DocOps Lab projects
GitHub Issues Types and Tasks
Tracking work for DocOps Lab projects
Product Change Tracking and Documentation
Integration and deployment/delivery process for DocOps Lab sites and artifacts.
Release Process (General)
Integration and deployment/delivery process for DocOps Lab sites and artifacts.
Ruby Development Style Guide
Ruby coding styles and conventions for DocOps Lab projects.
Specs & Tests
Specifying and testing DocOps Lab projects
Universal Project Attributes
Current status of all project info as AsciiDoc attributes
Using GitHub Issues
Tracking work for DocOps Lab projects