Documentation preview in pull requests

Open
#49 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
github
Domain
ci-cd, documentation

Research direction

Start by reviewing the referenced docker/docker.github.io repository and pull request 11476 to understand the documented preview approach, then inspect this repository for its documentation and pull-request automation entry points. Done means documentation changes in a pull request produce a reviewer-visible preview; the issue names no files or tests to run.

Written by the indexing model from the issue text.

Description

help wanted

Some github repos have mechanisms to show documentation preview in PRs, so that if any documentation is changed, a reviewer can see how it looks like. One such example is https://github.com/docker/docker.github.io (see e.g. docker/docker.github.io/pull/11476), implemented via netlify.

We need something like this, too.

Cc @thaJeztah

Dominant language
Go
Stars
101
Forks
61
Avg merge
2d 7h
Merged PRs (30d)
5

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from moby/sys

All issues in moby/sys

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.