# Contribute

Thank you for considering contributing to this DevOps knowledge base! This document provides guidelines and best practices for contributions.

## Content Guidelines

### File Structure

* Place new content in the appropriate section under `/pages`
* Create new directories when introducing new major topics
* Use README.md for section index pages

### Markdown Standards

* Use ATX-style headers (`#` for h1, `##` for h2, etc.)
* Use fenced code blocks with language specification:

  ````bash
  # This is a bash code block
  ```plaintext
  ````
* Include descriptive alt text for images
* Keep line length under 120 characters

### Metadata

All content pages should include YAML front matter:

````markdown
---
description: Brief description of the page content
keywords: keyword1, keyword2, keyword3
---
```plaintext

## Advanced GitBook Features

### Including Reusable Snippets

To include reusable content:

```markdown
{% include "/_snippets/snippet-name.md" %}
```plaintext

### Using Tabs

For comparing multiple implementations:

```markdown
{% tabs %}
{% tab title="Option 1" %}
Content for option 1
{% endtab %}
{% tab title="Option 2" %}
Content for option 2
{% endtab %}
{% endtabs %}
```plaintext

## Submitting Changes

1. Fork the repository
2. Create a new branch for your changes
3. Make your changes following these guidelines
4. Submit a pull request with a clear description of the changes

## Style Conventions

### Code Examples

- Include comments in code examples
- Use clear variable names
- Include explanations before and after complex code blocks

### Screenshots

- Place screenshots in `/assets/images/[section-name]/`
- Use descriptive filenames
- Keep image sizes reasonable (compress when appropriate)
````


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://freundcloud.gitbook.io/devops-examples-from-real-life/contributing.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.