docset

Documentation

Overview

Package docset keeps track of checkouts of a repository of Markdown documents and their rendered counterparts.

Index

• Variables
• func New(workDir string, docPath string, docsyDir string, repoURL string, ...) *docSet
• type DocSet

Variables

var (
	IssueClosedErr = errors.New("The requested issue has been merged or abandoned.")
)

Functions

func New

func New(workDir string, docPath string, docsyDir string, repoURL string, codeReview codereview.CodeReview, docsy docsy.Docsy) *docSet

New returns a new *docSet instance.

wordDir is the directory where both the raw and processed documentation live.

docPath is the relative path in the git repo where the docs are stored, e.g. "site" for Skia.

docsyDir is the directory containing Docsy. See https://docsy.dev.

repoURL is the URL of the repo passed to 'git clone'.

Types

type DocSet

type DocSet interface {
	// FileSystem returns a FileSystem of the rendered contents of the
	// documentation. Pass in the codereview.MainIssue to get the main branch.
	FileSystem(ctx context.Context, issue codereview.Issue) (http.FileSystem, error)

	// Start the long running process that checks for updated issues and cleans
	// up closed issues.
	Start(ctx context.Context) error
}

DocSet represents a set of hugo rendered documentation, one for the main branch, and then for any core review issues that contain documentation changes.

The DocSet will run a background tasks that monitors issues and updates the patchsets as they progress, and removes issues as they are closed.