Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 123 additions & 0 deletions pulpproject.org/help/community/publish-to-blog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# Publish to our blog

This guide will walk you through the process of contributing a blog post to the Pulp Project blog.

## Prerequisites

- A GitHub account
- Basic knowledge of Markdown
- Something you wanna share with the Pulp Project community!

## Overview

Blog posts for the Pulp Project are published through pull requests to the [pulp-docs repository](https://github.com/pulp/pulp-docs). All blog posts are written in Markdown and include metadata that helps organize and display the content properly.

## Step-by-step process

### 1. Create a branch on your fork

1. Fork the [pulp-docs repository](https://github.com/pulp/pulp-docs) on GitHub
2. Clone your fork to your local machine:
```bash
git clone https://github.com/YOUR_USERNAME/pulp-docs.git
cd pulp-docs
```
3. Create a branch to work on your post

### 2. Create your blog post file

Blog posts are organized by year.
Create your Markdown file in the appropriate year directory.
If your post requires images put them side-by-side with the post file:

```
pulpproject.org/blog/posts/YYYY/your-post-title.md
pulpproject.org/blog/posts/YYYY/my-image.png
pulpproject.org/blog/posts/YYYY/my-graph.svg
```

### 3. Add metadata

Every blog post must start with YAML front matter that includes the following required and optional fields:

```yaml
---
# requires
date: YYYY-MM-DD
title: Your Blog Post Title
authors:
- author-name

# optional
tags:
- tag1
- tag2
links:
- "[discourse] LTS strategy": "https://discourse.pulpproject.org/t/need-to-reduce-the-number-of-release-branches-aka-we-need-an-lts-strategy/449"
- "[discourse] CalVer": "https://discourse.pulpproject.org/t/switching-pulpcore-to-calendar-versioning-scheme/771"
---
```

About the metadata:

- **date**: The publication date and time
- **title**: The title of your blog post as it will appear on the blog
- **author**: Your author name as it shows in the *authors file* (see below)
- **tags**: A list of relevant tags to help categorize your post
- **links**: These are references you wanna share. These receive a special rendering.

!!! tip "Add yourself as an author"

Add an author entry to `pulpproject.org/blog/.authors.yml` by using others entries as a template.

Use that in the `authors` fields.

### 4. Write your content

After the front matter, add your blog post content using standard Markdown.

**Important**: Include the `<!-- more -->` comment after your opening paragraph or introduction. This creates a "read more" break on the blog index page:

```markdown
---
date: 2025-12-05
title: Getting Started with Pulp Container Registry
authors:
- jane-developer
tags:
- tutorial
- container
---

Learn how to set up and use Pulp as a container registry for your organization's Docker images.

<!-- more -->

## Introduction

In this tutorial, we'll walk through...
```

### 5. Preview and submit

Before submitting it's recommended that you preview your blog post locally.
A quick way to do it is run `pulp-docs` in the pulp-docs repository:

```bash
uv run pulp-docs serve --draft
```

When everything looks good, submit your PR and we'll review it!

!!! note "Issues with preview"

If you have problems with the preview, submit an issue [here](https://github.com/pulp/pulp-docs/issues/).

## Content guidelines

### Writing tips

- You may use AI, but use it wisely. See our [AI Policy](site:help/more/governance/ai_policy/)
- Link to relevant documentation and resources
- Run an appropriate tool to check for typos

53 changes: 16 additions & 37 deletions pulpproject.org/help/index.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,24 @@
---
render_macros: true
---
# Help

# Overview
Welcome to the Pulp Project community!
This section contains general resources and guides to help you in your journey.

:wave: Welcome to the help section!
## Community

If this is the first time navigating trough these docs, we recommend reading the [Documentation Usage](site:help/more/docs-usage/).
Understaning the docs will help you find what you need more quickly.
- **[Get Involved](site:help/community/get-involved/)** - Learn how to connect with the community, join our communication channels, and participate in meetings
- **[PulpCon](site:help/community/pulpcon/)** - Information about our annual community conference, including past editions and materials
- **[Publish to our blog](site:help/community/publish-to-blog/)** - Step-by-step guide for contributing blog posts to the Pulp Project blog

For some human help, you should visit the [Get Involved](site:help/community/get-involved/) section.
There you'll learn about how to can reach out to the Pulp Community.
## Stay Connected

Don't hesitate to contact us!

---

## Quick Links

!!! note "About versions"

The `version` column is the latest on main and it's what we publish.
- **[Community Forum](https://discourse.pulpproject.org/)** - Ask questions, share experiences, and connect with other users
- **[Matrix Chat Space](https://matrix.to/#/#pulp:matrix.org)** - Real-time discussions with the community and developers
- **[YouTube Channel](https://www.youtube.com/PulpProject)** - Demos, recordings, and community discussions

You might encounter some unreleased content live, but plugins usually release often.
Also, we try to include version information on the docs itself.
## More Resources

{%- for title, kind in [("Core", "Core"), ("Content Plugins", "Content"), ("Deployment", "Deployment"), ("Interaction", "Interaction"), ("Others", "Other")] %}
- **[Quick Links](site:help/more/quick-links/)** - Quick access to Pulp components links and versioning info
- **[Why Pulp?](site:help/more/why-pulp/)** - Learn about Pulp's benefits and use cases
- **[AI Policy](site:help/more/governance/ai_policy/)** - The project's policy on the use of AI and LLMs

### {{ title }}

Component | Version | Links | &nbsp; | &nbsp;
--- | --- | --- | --- | ---
{%- for component in components if component.kind == kind %}
{{ component.title }} | `{{ component.version }}` | {{ component.links | join(" | ") }}
{%- endfor %}
{%- endfor %}

## Changes RSS Feed

Check our recent releases with this [RSS changelog feed](https://himdel.eu/feed/pulp-changes.json).

{% for item in rss_items() %}
- [{{ item.title }}]({{ item.url }})
{% endfor %}
Don't hesitate to contact us!
33 changes: 33 additions & 0 deletions pulpproject.org/help/more/quick-links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
render_macros: true
---

# Quick Links

This page provides quick access to all Pulp components and their documentation, organized by category.

!!! note "About versions"

The `version` column is the latest on main and it's what we publish.

You might encounter some unreleased content live, but plugins usually release often.
Also, we try to include version information on the docs itself.

{%- for title, kind in [("Core", "Core"), ("Content Plugins", "Content"), ("Deployment", "Deployment"), ("Interaction", "Interaction"), ("Others", "Other")] %}

## {{ title }}

Component | Version | Links | &nbsp; | &nbsp;
--- | --- | --- | --- | ---
{%- for component in components if component.kind == kind %}
{{ component.title }} | `{{ component.version }}` | {{ component.links | join(" | ") }}
{%- endfor %}
{%- endfor %}

## Changes RSS Feed

Check our recent releases with this [RSS changelog feed](https://himdel.eu/feed/pulp-changes.json).

{% for item in rss_items() %}
- [{{ item.title }}]({{ item.url }})
{% endfor %}