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

📖 Fix formatting in docs #1466

Merged
merged 1 commit into from
Nov 14, 2024

Conversation

m1kola
Copy link
Member

@m1kola m1kola commented Nov 14, 2024

Description

Mostly fixes lists that render fine in GitHub, but not on the mkdocs website.

Also replaces several text notes with visual note blocks like we do in other places across our docs.

Tip

We also have docs deployment preview. See the comment from netlify bot below.

Tip

Recommend reviewing the changes with git diff --ignore-all-space (-w) option. GitHub UI also has this option.
Screenshot 2024-11-12 at 15 59 15

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

@m1kola m1kola requested a review from a team as a code owner November 14, 2024 14:52
Copy link

netlify bot commented Nov 14, 2024

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit c6c0485
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/67361281dedd160008968607
😎 Deploy Preview https://deploy-preview-1466--olmv1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Mostly fixes lists that render fine in GitHub, but not on
the mkdocs website.

Also replaces several text notes with visual note blocks
like we do in other places across our docs.

Signed-off-by: Mikalai Radchuk <[email protected]>
@m1kola m1kola force-pushed the various_formatting_fixes branch from f6d9e32 to c6c0485 Compare November 14, 2024 15:08
@m1kola m1kola requested a review from tmshort November 14, 2024 15:09
Copy link
Contributor

@tmshort tmshort left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 14, 2024
@tmshort tmshort added this pull request to the merge queue Nov 14, 2024
Merged via the queue into operator-framework:main with commit dd2074b Nov 14, 2024
17 checks passed
@m1kola m1kola deleted the various_formatting_fixes branch November 14, 2024 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants