Skip to content

Conversation

@camilamacedo86
Copy link
Member

@camilamacedo86 camilamacedo86 commented Nov 2, 2025

The following changes impact mainly the tutorials.
To review see:

Documentation Improvements Summary

Changes

Content Cleanup:

  • Hidden Apache License and Import blocks
  • Hidden closing braces in tests
  • Removed duplicate collapse markers
  • Fixed extra } appearing outside code blocks

Label Updates:

  • "Clock" → "Clock Code Implementation"
  • "Go imports" → "Imports"
  • "Validate object name" → "validateCronJobName() Code Implementation"
  • "old stuff" → "Remaining code from "
  • "The rest of Spec" → "CronJobSpec Full Code"

Related: #4862

@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 2, 2025
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 2, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86

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

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 2, 2025
@camilamacedo86 camilamacedo86 force-pushed the docs-css-improvements branch 3 times, most recently from b0f9039 to b1949ee Compare November 2, 2025 23:57
@camilamacedo86 camilamacedo86 changed the title WIP: Docs css improvements 📖 Documentation Improvements Nov 3, 2025
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 3, 2025
@camilamacedo86 camilamacedo86 changed the title 📖 Documentation Improvements 📖 Improve collapsible code sections and formatting of tutorials Nov 3, 2025
@camilamacedo86 camilamacedo86 force-pushed the docs-css-improvements branch 3 times, most recently from 691368a to bb292f8 Compare November 3, 2025 10:01
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 3, 2025
vitorfloriano

This comment was marked as resolved.

@vitorfloriano

This comment was marked as resolved.

@camilamacedo86 camilamacedo86 force-pushed the docs-css-improvements branch 2 times, most recently from 7777c59 to 9139489 Compare November 4, 2025 19:24
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Nov 4, 2025
@camilamacedo86

This comment was marked as outdated.

Copy link
Contributor

Choose a reason for hiding this comment

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

@camilamacedo86 I checked the preview and it seems that some copy buttons are still missing. See: https://deploy-preview-5175--kubebuilder.netlify.app/cronjob-tutorial/empty-main#every-journey-needs-a-start-every-program-needs-a-main

In code blocks that they are not missing, they are misplaced. See: https://deploy-preview-5175--kubebuilder.netlify.app/cronjob-tutorial/cronjob-tutorial#scaffolding-out-our-project

The custom CSS seems to be affecting how the copy buttons are displayed.

For testing, I checked out your PR and served the book using mdBook v0.4.40, then I deleted the custom CSS to see what happens and all the code blocks displayed the copy button properly (other parts broke, though 😅):

Image

Copy link
Member Author

Choose a reason for hiding this comment

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

/hold

I will be looking on that
Good catcher.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @camilamacedo86

I fixed the issue with the copy button and the license blocks. See #5184 and #5183.

@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 5, 2025
Copy link
Contributor

@vitorfloriano vitorfloriano left a comment

Choose a reason for hiding this comment

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

@camilamacedo86 I'm working on improving the theme colors in the docs in a more maintainable manner and will share the PR soon. You gon' love it! 😍

So, I suggest you restore the changes in markers.css just so we don't have any conflicting CSS rules.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @camilamacedo86

I fixed the issue with the copy button and the license blocks. See #5184 and #5183.

@camilamacedo86
Copy link
Member Author

@camilamacedo86 I'm working on improving the theme colors in the docs in a more maintainable manner and will share the PR soon. You gon' love it! 😍

Regards the style here I will revert all and keep just the collapse ones
Just to share and thx a lot for the help.

@camilamacedo86
Copy link
Member Author

@vitorfloriano
I think we can move forward with this one now.

Here’s what we’re doing here:

  1. Hiding the license and Go imports (they don’t add value to the tutorials)
  2. Fixing a few spots that weren’t properly closed

That said, we definitely need to work more on improving the snippet rendering — maybe revisit the layout of the collapse component and related details. Your help is very welcome !!!

@camilamacedo86
Copy link
Member Author

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 9, 2025
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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants