feat: SHIP-0041 Documentation Restructure #264
+213
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This propsal calls for the Shipwright documentation to be restructured in a manner that adheres to CNCF best practices for sandbox projects. The recommendations here are largely based on the CNCF Sandbox Primer for tech docs [1] and the "Docs for Developers" guide [2]. [1] https://github.com/cncf/techdocs/blob/main/docs/sandbox-doc-primer.md [2] https://docsfordevelopers.com/ Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
openshift-ci
bot
added
the
kind/feature
pull-request-size
bot
added
the
size/L
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This propsal calls for the Shipwright documentation to be restructured in a manner that adheres to CNCF best practices for sandbox projects. The recommendations here are largely based on the CNCF Sandbox Primer for tech docs [1] and the "Docs for Developers" guide [2].
[1] https://github.com/cncf/techdocs/blob/main/docs/sandbox-doc-primer.md
[2] https://docsfordevelopers.com/
/kind feature
Submitter Checklist
See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.
Release Notes