shipwright-io / build

Shipwright - a framework for building container images on Kubernetes

https://shipwright.io

Apache License 2.0

626 stars 107 forks source link

docs: fix broken links, tables and typos #1632

Open avinal opened 1 week ago

avinal commented 1 week ago

Changes

fixes typos and grammatical mistakes
reformatted tables
fix broken references to old files and links

Signed-off-by: Avinal Kumar avinal@redhat.com

Fixes #1042

Submitter Checklist

[ ] Includes tests if functionality changed/was added
[x] Includes docs if changes are user-facing
[x] Set a kind label on this PR
[x] Release notes block has been filled in, or marked NONE

See the contributor guide for details on coding conventions, github and prow interactions, and the code review process.

Release Notes

NONE

openshift-ci[bot] commented 1 week ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Once this PR has been reviewed and has the lgtm label, please assign qu1queee for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/shipwright-io/build/blob/main/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

avinal commented 1 week ago

/kind documentation

avinal commented 1 week ago

From last community call, I have scoped down and ignored other formatting, front matter and headings. I have also ignored the proposals directory to retain its historical significance. Please let me know if I should include the directory.

Other issues/improvement related to docs should be moved to a new EPIC.

qu1queee commented 1 week ago

@avinal ignoring the proposals directory makes sense