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

feat: develop Tetragon Use Cases pages #3277

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

Conversation

annaindistress
Copy link
Contributor

@annaindistress annaindistress commented Jan 6, 2025

Describe what changes this pull request brings

  • Developed 7 Use Case Pages
  • Added a new dropdown to the Header
  • Refactored the Conference Talks table. Moved video data to docs/data in YAML for reuse
  • Moved the social section to a partial for easier reuse in layouts

NOTE: the video section on the main page hasn’t been updated to use shared data. Let me know if you’d like me to adjust it to show the last 3 videos from table with the current design

Steps to check:

  1. Open preview:

  2. Make sure that everything looks and works as expected

@annaindistress annaindistress requested review from mtardy and a team as code owners January 6, 2025 12:39
Copy link

netlify bot commented Jan 6, 2025

Deploy Preview for tetragon ready!

Name Link
🔨 Latest commit 26295b7
🔍 Latest deploy log https://app.netlify.com/sites/tetragon/deploys/677d01ccf610230009765ceb
😎 Deploy Preview https://deploy-preview-3277--tetragon.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.

@mtardy mtardy added area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation. labels Jan 6, 2025
Copy link
Member

@mtardy mtardy left a comment

Choose a reason for hiding this comment

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

Hey thanks Anna this looks good, I'll review it quickly, could you maybe split this into the logical commits you described in the PR description?

  • Developed 7 Use Case Pages
  • Added a new dropdown to the Header
  • Refactored the Conference Talks table. Moved video data to docs/data in YAML for reuse
  • Moved the social section to a partial for easier reuse in layouts

This would make 4 nice commits I imagine and would be easier to review.

By the way, nice initiative with "Refactored the Conference Talks table. Moved video data to docs/data in YAML for reuse", this looks great like that, that's a very good idea.

When on your working branch, you can easily do git reset HEAD~ and then git add the appropriate parts and git commit -s so that you create 4 separate commits. That would be great, thanks.

Feel free to ask again for review with the GH button when done.

@annaindistress annaindistress force-pushed the use-cases branch 2 times, most recently from d9e78c0 to 5ad45ea Compare January 7, 2025 09:14
@annaindistress annaindistress requested a review from mtardy January 7, 2025 09:20
Signed-off-by: Anna Artemova <[email protected]>
Copy link
Member

@mtardy mtardy left a comment

Choose a reason for hiding this comment

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

From a technical PoV on the docs, this change looks good to me! Thanks, this is really well done.

I would just wait for Paul to look at the use cases since I think it's the one that initiated this and I didn't look at the content.

Comment on lines -25 to -34
.td-navbar-nav-scroll {
height: auto;
}
.navbar-nav {
padding-bottom: 0;
overflow: hidden;
}
}

@media screen and (max-width: 767px) {
Copy link
Member

Choose a reason for hiding this comment

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

curious: why did we needed to remove this media size and change the other from 767 to 991.98px?

Copy link
Member

Choose a reason for hiding this comment

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

Never a super fan to get away from the original theme, but since this doesn't exist this is the only solution. It seems the community has been asking for it google/docsy#311 if you ever want to upstream this and do some OSS work :). You can see another person's version here google/docsy#311 (comment).

Comment on lines +99 to +103
[[menu.navbar_main]]
name = "Capabilities Monitoring"
parent = "use-cases"
url = "/use-cases/capabilities-monitoring"
weight = 1
Copy link
Member

Choose a reason for hiding this comment

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

It looks like your version looks great and I have not dive into the technical details, so maybe ignore this totally: but I was wondering if it would have been possible to do something like [[menu.navbar_main.use-cases]] and then declare each use-cases using this.

@@ -478,7 +478,7 @@ <h2 class="title videos__title">
<ul class="videos__list">
<li>
<a href="https://www.youtube.com/watch?v=u8HKg5pENj4" target="_blank" rel="noopener noreferrer">
<img src="/images/cover-log4shell.jpg" width="640" height="360" loading="lazy" alt="youtube video cover of log4shell presentation">
<img src="/images/video-preview/the-next-log4jshell.jpg" width="640" height="360" loading="lazy" alt="youtube video cover of log4shell presentation">
Copy link
Member

Choose a reason for hiding this comment

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

nit: indentation looks off

Copy link
Member

Choose a reason for hiding this comment

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

ah nevermind, this is because you change it in a later commit, ignore this :)

Copy link
Member

Choose a reason for hiding this comment

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

Thanks this is really great!

Copy link
Member

Choose a reason for hiding this comment

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

I must say I'm impressed on how you made those use cases easy to write: you really use Hugo here to generate those pages and that's cool! Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants