goharbor / goharbor/community

Proposal: Add Contributors Guide Series to Harbor Documentation

Open
#295 4 comments 0 reactions 1 assignee Claimed by @OrlinVasilev View on GitHub
Dominant language
No language data
Stars
82
Forks
92
PR merge metrics
No merged PRs in 30d

Description

## Overview

I propose creating **"The Contributors Guide to Harbor"** — a multi-part Medium series designed to help new contributors understand and navigate Harbor's ecosystem.

The series would be maintainer-owned (landing page on Medium) with individual parts contributed by community members.

## Problem

New contributors struggle to:
- Understand the relationship between Harbor's multiple repositories
- Find the right project for their skills and interests
- Get oriented in the container registry domain

## Solution

A narrative, guided introduction spanning:
- **Part 1:** Ecosystem overview (all repositories, their purpose, how they connect)
- **Part 2+:** Deep dives into architecture, deployment, CLI, etc.

## Proposed Structure

**Maintainer creates** One landing post on Medium that links to all parts
- Single URL for README, docs, and Slack
- Update it whenever a new part publishes (just add a link)
- You control the series direction

**Contributors** write Individual parts on their own Medium accounts

- I write Part 1 and publish on my account
- Maintainer links to it from the landing post
- Future contributors do the same for Part 2, 3, etc.

**Result:** One official index that never changes, with individual parts linked from it.

## Why This Matters (vs. other guides online)

There are many contributor guides online, but this is different:

- **Series continuity:** Single maintainer-owned landing page that links all parts (not scattered articles).
- **Official curated content:** Maintainer controls the narrative and keeps it updated.
- **Community-contributed, maintainer-owned:** Individual parts authored by contributors, but series direction owned by Harbor maintainers
- **Sustainable:** Not dependent on a single external contributor disappearing

This ensures the guide stays current, cohesive, and officially endorsed.

## Benefits

- Lowers barrier to entry for new contributors
- Surfaces all Harbor repositories equally
- Sustainable handoff model (not dependent on single author)
- Improves discoverability through SEO-friendly content

## Current Status

- Part 1 draft complete (ready for review)
- Not yet published to Medium (awaiting approval)
- Awaiting maintainer decision on landing post

## What I Need

1. Maintainer feedback on the proposal
2. Decision: Will you create the landing Medium post?
3. Once approved, I'll publish Part 1 and we'll add to README.

## Next Steps

I can:
- Share Part 1 draft for review
- Help design the README integration through a PR.
- Coordinate the Medium post structure

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.