Skip to content

Ready case studies shortcode for Docsy #50983

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Ready case studies shortcode for Docsy #50983

wants to merge 1 commit into from
+65 −16

Conversation

lmktfy
Copy link
Contributor

@lmktfy lmktfy commented May 19, 2025 •
edited
Loading

Revise a shortcode that renders a selection of case studies. Also update the SCSS to make it look about right.

This changes the HTML on the site landing page(s), not the rendering within the Case Studies section.

Here's a preview

Helps with issue #41171
Supersedes PR #48560

/area web-development

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes sig/docs Categorizes an issue or PR as relevant to SIG Docs. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 19, 2025
@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 salaxander for approval. For more information see the 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 requested a review from katcosgrove May 19, 2025 20:33
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 19, 2025
@lmktfy lmktfy mentioned this pull request May 19, 2025
Closed
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 19, 2025
@netlify Netlify
Copy link

netlify bot commented May 19, 2025 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 94de6f5
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/682b9b9f77b1e6000842952e
😎 Deploy Preview https://deploy-preview-50983--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 project configuration.

@lmktfy
Ready case studies shortcode for Docsy
94de6f5 
This changes the HTML on the site landing page(s), not the rendering
within the Case Studies section.
@lmktfy lmktfy force-pushed the 20241027_ready_case_studies_shortcode_docsy branch from db2d75a to 94de6f5 Compare May 19, 2025 20:59
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 19, 2025
@lmktfy lmktfy marked this pull request as ready for review May 19, 2025 20:59
@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 May 19, 2025
@k8s-ci-robot k8s-ci-robot requested a review from natalisucks May 19, 2025 20:59
shurup
shurup reviewed May 20, 2025
View reviewed changes
Copy link
Member

@shurup shurup left a comment

Choose a reason for hiding this comment

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

Great work! I checked how it renders in Firefox and Chrome, and it looks good. I have a couple of minor suggestions for improving CSS for smaller screens.

assets/scss/_custom.scss
> .case-study-item {
display: flex;
flex-direction: column;
justify-content: space-between;
Copy link
Member

Choose a reason for hiding this comment

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

Centering the text makes it look better (e.g. relative to the logo above), especially for small screens (tablets/phones).

Suggested change
justify-content: space-between;
justify-content: space-between;
text-align: center;

assets/scss/_custom.scss
display: block;
text-align: right;
}
padding-bottom: 2em;
Copy link
Member

Choose a reason for hiding this comment

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

Moving this to an upper level (list instead of the item) keeps the same padding below the whole section, yet doesn't add unnecessary paddings when the items are displayed in 2 or 4 rows (it happens on smaller screens).

Suggested change
padding-bottom: 2em;

assets/scss/_custom.scss
text-align: right;
}
padding-bottom: 2em;
}
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
}
}
padding-bottom: 2em;

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shurup shurup shurup left review comments

@divya-mohan0209 divya-mohan0209 Awaiting requested review from divya-mohan0209

@katcosgrove katcosgrove Awaiting requested review from katcosgrove

@natalisucks natalisucks Awaiting requested review from natalisucks

Assignees
No one assigned
Labels
area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lmktfy @k8s-ci-robot @shurup