Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix broken links, tables and typos #1632

Merged
merged 1 commit into from
Jul 8, 2024

Conversation

avinal
Copy link
Contributor

@avinal avinal commented Jun 25, 2024

Changes

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

Signed-off-by: Avinal Kumar [email protected]

Fixes #1042

Submitter Checklist

  • Includes tests if functionality changed/was added
  • Includes docs if changes are user-facing
  • Set a kind label on this PR
  • 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

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

Signed-off-by: Avinal Kumar <[email protected]>
@openshift-ci openshift-ci bot added the release-note-none Label for when a PR does not need a release note label Jun 25, 2024
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 25, 2024
@avinal
Copy link
Contributor Author

avinal commented Jun 25, 2024

/kind documentation

@openshift-ci openshift-ci bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 25, 2024
@avinal
Copy link
Contributor Author

avinal commented Jun 25, 2024

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
Copy link
Contributor

@avinal ignoring the proposals directory makes sense

Copy link
Contributor

@qu1queee qu1queee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, good job!

/lgtm
/approved

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jun 27, 2024
@qu1queee qu1queee removed the request for review from SaschaSchwarze0 July 1, 2024 14:22
Copy link
Member

@adambkaplan adambkaplan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

Looks good 🎉

Copy link
Contributor

openshift-ci bot commented Jul 8, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: adambkaplan

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

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 8, 2024
@openshift-merge-bot openshift-merge-bot bot merged commit 28d8b8b into shipwright-io:main Jul 8, 2024
13 checks passed
@adambkaplan adambkaplan added this to the release-v0.14.0 milestone Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note-none Label for when a PR does not need a release note size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Revisit existing documentation
3 participants