carvel-dev / carvel-dev/kapp-controller

Standardize documentation approach for package authors

Open
#301 1 comment 1 reaction 0 assignees View on GitHub
carvel-accepted enhancement priority/important-longterm
Dominant language
Go
Stars
323
Forks
127
Avg merge
2d 16h
Merged PRs (30d)
4

Description

**Describe the problem/challenge you have**

Package authors need a means of providing shipping documentation alongside their package. Ideally, the documentation source could live alongside the package itself such that it could be consumed and rendered in a variety of location. By providing specification or standards for package docs, we could ensure any package could be supported in a variety of catalogs, docs sites, tooling etc.

Consider the following example:

![image](https://user-images.githubusercontent.com/6200057/126230462-dc835dbf-f377-4c1a-ba20-dc4353094869.png)

In the above, docs are stored inside the repo bundle. This could also enable docs to be rendered in a variety of ways, including air-gapped environments.

---
Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible"
👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help working on this issue.

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.