Skip to content

docs: changes in markdown for readability#106

Open
msdolbey wants to merge 2 commits intovelero-io:mainfrom
msdolbey:main
Open

docs: changes in markdown for readability#106
msdolbey wants to merge 2 commits intovelero-io:mainfrom
msdolbey:main

Conversation

@msdolbey
Copy link
Copy Markdown

Signed-off-by: msdolbey dolbes@gmail.com

This is a minor nit, but saw this and changed it on the README -
On main:
Screen Shot 2022-10-30 at 7 08 38 AM

With changes:
Screen Shot 2022-10-30 at 7 07 52 AM

markdown didn't like this when it was indented in without a list

Signed-off-by: msdolbey <dolbes@gmail.com>
@@ -0,0 +1,3 @@
## All changes

- made some markdown changes in the README (#xx, @msdolbey) No newline at end of file
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- made some markdown changes in the README (#xx, @msdolbey)
- made some markdown changes in the README (#106, @msdolbey)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks.
Plugins don't use these changelog files to generate the release note, so I think it's OK to not change. I will manually create the release note for GA.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jul 21, 2023

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 21.36%. Comparing base (4a46a41) to head (29cee0d).
⚠️ Report is 98 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #106   +/-   ##
=======================================
  Coverage   21.36%   21.36%           
=======================================
  Files           3        3           
  Lines         482      482           
=======================================
  Hits          103      103           
  Misses        375      375           
  Partials        4        4           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@jglick jglick left a comment

Choose a reason for hiding this comment

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

There are more code block problems that are not fixed here. See #97.

@blackpiglet
Copy link
Copy Markdown
Collaborator

There are more code block problems that are not fixed here. See #97.

I put some comments in #97
My opinion is just fixing the blocks impacting the MarkDown display is enough, but open to other options.

kaovilai pushed a commit to kaovilai/velero-plugin-for-gcp that referenced this pull request Apr 17, 2026
Co-authored-by: Rayford Johnson <rayfordj@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants