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

Enhance YAML Formatting for Implicit Keys in mkdocs/docs #4908

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

andoriyaprashant
Copy link
Contributor

Fixes #4907

Proposed changes

This pull request resolves the issue of improper YAML formatting in the mkdocs/docs folder, where implicit keys were split across multiple lines. The affected keys have been adjusted to adhere to YAML standards by consolidating them onto single lines or using folded block scalars where appropriate. These changes eliminate parsing errors and ensure smoother documentation processing

Types of changes

What types of changes does your code introduce to Litmus? Put an x in the boxes that apply

  • New feature (non-breaking change which adds functionality)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices applies)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • I have signed the commit for DCO to be passed.

description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources $3 $3'
Copy link
Member

Choose a reason for hiding this comment

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

Can we update the manifest for versions 3.8.0 and above while skipping changes for older versions?

@namkyu1999 namkyu1999 added the need-approvers-review Reminder label to the codeowners/maintainers for stale PRs that are more that 2 weeks old label Nov 15, 2024
@Saranya-jena
Copy link
Contributor

@andoriyaprashant are you still working on this PR?

@andoriyaprashant
Copy link
Contributor Author

@andoriyaprashant are you still working on this PR?

yes mam

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue need-approvers-review Reminder label to the codeowners/maintainers for stale PRs that are more that 2 weeks old
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implicit Keys Need to Be on a Single Line
4 participants