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: auth blog post #23

Closed
wants to merge 1 commit into from
Closed

docs: auth blog post #23

wants to merge 1 commit into from

Conversation

grampelberg
Copy link
Owner

@grampelberg grampelberg commented Sep 19, 2024

Summary by Sourcery

Add a new blog section to the documentation, including a post on simplifying Kubernetes authentication with OpenID Connect. Enhance the Tailwind CSS configuration to center content across the site.

New Features:

  • Introduce a new blog section in the documentation with a dedicated page for blog posts, including a new blog post titled 'Stop Making Kubernetes Auth Hard'.

Enhancements:

  • Add a centralized container configuration in the Tailwind CSS setup to ensure content is centered across the documentation site.

Documentation:

  • Add a new blog post discussing Kubernetes authentication, focusing on simplifying the process using OpenID Connect and RBAC.

Copy link

vercel bot commented Sep 19, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
kty ✅ Ready (Inspect) Visit Preview 32 resolved Sep 20, 2024 9:50pm

Copy link

sourcery-ai bot commented Sep 19, 2024

Reviewer's Guide by Sourcery

This pull request adds a new blog post about Kubernetes authentication and authorization, along with the necessary infrastructure to support a blog section in the documentation. The changes include updates to the project's TODO list, modifications to the documentation structure, and the addition of new files for the blog functionality.

File-Level Changes

Change Details Files
Add a new blog post about Kubernetes authentication and authorization
  • Create a detailed blog post explaining Kubernetes auth concepts
  • Discuss authentication methods, focusing on OpenID Connect (OIDC)
  • Explain authorization using RBAC
  • Provide practical advice for implementing auth in Kubernetes
docs/pages/blog/2024-09-19-auth-isnt-hard.mdx
Implement blog functionality in the documentation
  • Add a new 'Blog' entry to the documentation navigation
  • Create a React component to render the blog list
  • Implement a custom layout for blog posts
  • Add a new page to serve as the blog index
docs/pages/_meta.js
docs/components/blog.tsx
docs/pages/blog/_meta.tsx
docs/pages/blog.mdx
Update project configuration files
  • Modify Tailwind configuration to center container content
  • Update TypeScript configuration to set a base URL
  • Remove some completed or outdated TODO items
  • Add new TODO items related to upcoming features or bug fixes
docs/tailwind.config.js
docs/tsconfig.json
TODO.md

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @grampelberg - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

const Blog = () => {
const { asPath } = useRouter()

let linkClasses = [
Copy link

Choose a reason for hiding this comment

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

suggestion: Consider extracting class list

The list of classes is quite long. Consider extracting this into a separate constant or utility function to improve readability and maintainability of the component.

const LINK_CLASSES = [
  'border',
  'border-zinc-200',
  // ... other classes
]

const Blog = () => {
  const { asPath } = useRouter()

  const linkClasses = LINK_CLASSES

- Move YAML over to viewport. Should viewport be doing syntax highlighting by
default? How do we do a viewport over a set of lines that require history to
do highlighting?

- There's a bug somewhere in `log_stream`. My k3d cluster restarted and while I
could get all the logs, the stream wouldn't keep running - it'd terminate
immediately. `stern` seemed to be working fine. Recreating the cluster caused
immediately. `stern` seemed to be working fine. Recreating the cluster causedx
Copy link

Choose a reason for hiding this comment

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

issue (documentation): Fix typo: 'causedx' should be 'caused'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant