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.

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

Import generated Kubernetes operator API docs for version 2.8 release [IPE-970] #838

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

Import generated Kubernetes operator API docs for version 2.8 release [IPE-970] #838

wants to merge 6 commits into from
+175 −72

Conversation

BrianMMcClain
Copy link
Contributor

@BrianMMcClain BrianMMcClain commented Feb 21, 2025 •
edited
Loading

🔍 Deploy Preview

What

Regenerate API docs for version 2.8 of the Kubernetes operator

Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

  • One or more labels describe the type of change (e.g. clarification) and associated product (e.g. HCP Terraform ).
  • Description links to related pull requests or issues, if any.

Content

  • Redirects have been added to website/redirects.js for moved, renamed, or deleted pages.
  • API documentation and the API Changelog have been updated.
  • Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
  • Pages with related content are updated and link to this content when appropriate.
  • Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
  • New pages have metadata (page name and description) at the top.
  • New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
  • New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
  • UI elements (button names, page names, etc.) are bolded.
  • The Vercel website preview successfully deployed.

Reviews

  • I or someone else reviewed the content for technical accuracy.
  • I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

@BrianMMcClain BrianMMcClain added documentation Improvements or additions to documentation HCP Terraform labels Feb 21, 2025
@BrianMMcClain BrianMMcClain requested a review from a team February 21, 2025 14:42
@vercel Vercel
Copy link

vercel bot commented Feb 21, 2025 •
edited
Loading

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

Name Status Preview Comments Updated (UTC)
terraform-docs-common ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 21, 2025 3:37pm

@BrianMMcClain BrianMMcClain marked this pull request as draft February 21, 2025 14:43
@BrianMMcClain BrianMMcClain marked this pull request as ready for review February 21, 2025 15:40
@BrianMMcClain BrianMMcClain changed the title Import generated Kubernetes operator API docs for version 2.8 release Import generated Kubernetes operator API docs for version 2.8 release [IPE-970] Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation HCP Terraform
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@BrianMMcClain