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: shortcode formatting and typo(s) #48622

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

Conversation

Thoughtscript
Copy link

@Thoughtscript Thoughtscript commented Nov 2, 2024

Description

Some small changes to documentation to get familiar with CI/CD, tooling, etc.

Thanks!

Issue

  1. Some nitpicks/fairly trivial typos fixed.

  2. Per API style/conventions guide #26190 - Shortcode command looks like it should be background highlighted but isn't wrapped by a p tag.

    Screenshot:

    Screenshot 2024-11-02 120712

    Should be:

    image

Think the include and shortcode gets used in all of the language translations.

Reviewers: you can see an example of the change on this page /docs/tasks/inject-data-application/define-command-argument-container/

Closes: #48621

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 2, 2024
@k8s-ci-robot
Copy link
Contributor

[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 tengqm 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:

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

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Nov 2, 2024
@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 2, 2024
Copy link

netlify bot commented Nov 2, 2024

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit e547736
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67279da226c04600081fceea
😎 Deploy Preview https://deploy-preview-48622--kubernetes-io-main-staging.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.

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 2, 2024
Co-authored-by: Arvind <aruparekh@gmail.com>
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Sorry about misunderstanding the change before. To make this easiest to review, please split this PR into two:

  • one PR that changes the shortcode only
  • one PR that only fixes English content

/hold
pending that split

OK to unhold if the PR is now a single commit that only includes one of the above changes.

@Thoughtscript if you're not sure about how to do that split, we're happy to explain further.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants