Docusaurus migration #495
Open
Docusaurus migration #495
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
- Created a new Testimonials section with styles for layout and design. - Added a Use Cases component showcasing various real-world applications of KServe. - Introduced corresponding CSS styles for both components to enhance visual appeal. - Updated custom CSS variables for a consistent color scheme across the site. - Enhanced the homepage layout with new sections including Why KServe, Key Highlights, and more. - Added various adopter logos and images to enrich the visual content of the site. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
- Introduced new YAML configurations for serving TorchScript models with transformers. - Added XGBoost model serving documentation, including training, deployment, and testing instructions. - Created example input JSON files for XGBoost and TorchScript models. - Updated CSS styles for the homepage to enhance the layout and presentation of benefits. - Improved the homepage content to highlight features for Generative and Predictive AI. - Added model settings and requirements files for XGBoost serving. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…esponsive adjustments Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…g in the benefits section Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…enceService description Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…tructions Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
… Node.js setup, enhance permissions, and streamline build process Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
… into a single step for improved clarity and efficiency Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…ath, project name, and fix image path Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
… HomepageArchitecture components Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…pageShowcase, and index page components Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…component; remove unused kserve_layer image Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…lights, and HomepageTestimonials components and styles; update index page headings for clarity Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…t with benefits sections for Generative and Predictive AI; adjust index.tsx to include new component Update navigation label from 'Documentation' to 'Docs' in docusaurus.config.ts Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…nt out unused global styles and media queries Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…nd structure; add verification steps for prerequisites and installation instructions for Kind and Minikube Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
… LLM, update links to first InferenceService, and enhance Swagger UI section with usage examples and images. Refactor docs structure and add GenAI tutorial Replaces sklearn iris example with modern Qwen LLM tutorial to better showcase KServe's generative AI capabilities. Updates documentation structure by reorganizing getting-started section and moving swagger UI content to appropriate location. Enhances first-time user experience by demonstrating OpenAI-compatible APIs and enterprise features like autoscaling and GPU acceleration. Adds comprehensive examples for different deployment scenarios and client interactions. Updates all internal links and navigation to reflect new documentation organization. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Enhances the getting started documentation by adding prerequisites section to ensure users have proper setup before deploying models. Fixes broken internal links across multiple documentation files to prevent navigation issues. Refactors the introduction page to better highlight KServe's GenAI-first capabilities and enterprise features, providing clearer value proposition for new users. Updates community links to reflect the move to CNCF Slack and removes outdated contact information. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…odel name to "qwen-llm", adjust resource requests, and update inference request host. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…pdown links Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Removes default Docusaurus blog posts and replaces them with KServe-specific content Adds comprehensive release announcements for KServe v0.14 and v0.15, highlighting new features like Python inference clients, model caching, Hugging Face integration, and generative AI capabilities Updates author profiles and tag configurations to reflect KServe maintainers and project-relevant categories Includes supporting images for model cache architecture and generative inference workflows Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…0.14.0; chore: Update authors and tags for new contributors and project announcements - Added new contributors to authors.yml. - Updated tags.yml to include announcements category. fix: Update Docusaurus configuration for version announcement and links Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
…mermaid Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
- Introduced a new document for the Binary Tensor Data Extension, detailing its purpose, parameters, HTTP headers, data representation, examples, client implementation, performance benefits, best practices, limitations, and next steps. - Created a comprehensive overview of the Open Inference Protocol (V2), including API endpoints, payload contents, health checks, and gRPC API definitions. - Established a new section for KServe architecture, outlining the control plane and data plane concepts, deployment modes, and links to relevant documentation. - Added a resources section detailing KServe's custom resources, including InferenceService, InferenceGraph, ServingRuntime, and storage resources. - Updated the sidebar configuration to include new concepts and resources categories for better navigation. - Included new images for data plane representation and generative inference. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
✅ Deploy Preview for elastic-nobel-0aef7a ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
sivanantha321
force-pushed
the
docusaurus-migration
branch
from
abec5e9 to
abc50f5
Compare
Enables automatic configuration updates for Netlify deploy previews by setting the correct base URL and deploy URL in the Docusaurus configuration. Integrates a Node.js script that modifies the configuration file during the build process to ensure preview deployments work correctly with the proper URLs. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
sivanantha321
force-pushed
the
docusaurus-migration
branch
from
3283c0a to
19a0d04
Compare
…ure store integration - Created a new guide on writing a custom transformer for KServe, detailing the implementation of pre/post processing with TorchServe. - Added example code for a custom image transformer using KServe Model API. - Included instructions for building and deploying a transformer Docker image. - Documented the process of creating an InferenceService with REST and gRPC predictors. - Introduced a new section on deploying an InferenceService with Feast feature store, including Redis setup and feature server deployment. - Updated sidebars to include new transformer documentation links. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
sivanantha321
force-pushed
the
docusaurus-migration
branch
from
f215723 to
8dc60a5
Compare
Introduces new documentation sections for model explainability and monitoring, including overviews and practical examples with Alibi, TrustyAI, AIF360, and ART integration. Updates the sidebar to provide clearer navigation and access to guides on deploying and interpreting model explainers and detectors in KServe. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Ensures readers access documentation relevant to the specific KServe release discussed. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
@terrytangyuan They are pointing to the respective equivalent archive website link. So the users will be redirected to the archive website. |
Introduces detailed documentation on various KServe inference logging configurations, including basic logging, request header logging, TLS security, Knative Eventing integration, and blob storage support. Improves discoverability by updating sidebar navigation. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
sivanantha321
force-pushed
the
docusaurus-migration
branch
from
300122a to
9f69f0b
Compare
Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Introduces comprehensive documentation and examples for deploying multi-stage image classification pipelines using InferenceGraph, including model architecture, handlers, configuration, and step-by-step guides. Improves discoverability with sidebar updates and links to conceptual guidance, enabling users to build conditional model chains for advanced ML workflows. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Introduces detailed documentation for autoscaling InferenceServices using Knative Pod Autoscaler (KPA), Kubernetes HPA, and KEDA event-driven autoscaler. Enhances the documentation structure with a dedicated autoscaling category in the sidebar for easier navigation and discoverability. The new docs provide practical examples, configuration options, and guidance for scaling based on concurrency, QPS, CPU/memory, and custom metrics, addressing common user questions and improving onboarding for advanced scaling scenarios. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Replaces outdated architecture images with updated versions and adjusts references to reflect new file locations. Removes redundant and unused image assets to streamline the documentation and ensure consistency across site content. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Introduces guides explaining node selectors, affinity, taints, and tolerations for InferenceService scheduling in Kubernetes clusters. Provides detailed usage examples and diagrams to help users control pod placement and leverage raw/serverless deployment modes. Updates sidebar navigation to include the new node scheduling documentation. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Introduces comprehensive documentation for all supported model storage providers in KServe, including S3, GCS, Azure, Hugging Face, PVC, OCI images, and HTTP(S) URIs. Details configuration steps, authentication, and example workflows for deploying models from each source. Adds in-depth guidance for configuring custom storage containers and the ClusterStorageContainer CRD, enabling advanced storage strategies and custom protocol support. Provides instructions on handling self-signed certificates with storage initializers, covering both global and per-namespace configuration. Updates sidebar navigation to organize storage documentation and improve discoverability. Addresses gaps in previous documentation by replacing placeholders and removing obsolete files. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
|
Sounds great |
Updates documentation to reflect the replacement of the --disable_postprocess flag with --return_raw_logits for accessing raw model outputs in Hugging Face predictive inference guides. Clarifies usage and benefits for users requiring unprocessed logits. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Expands the configuration guide with detailed documentation for all ConfigMap-based global settings affecting KServe InferenceService components. Covers ingress, storage, credentials, deployment, resource defaults, logging, batching, routing, security, metrics, and more. Aims to help administrators understand and manage cluster-wide defaults, and clarifies how per-service overrides interact with global settings. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
- Created a new documentation file for the KServe Python Serving Runtime SDK, detailing installation, usage, and storage API features. - Added a script to generate API documentation for the Python Runtime SDK using pydoc-markdown, including virtual environment setup and frontmatter addition. - Introduced a configuration file for pydoc-markdown to specify documentation generation settings. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
… scripts - Updated the Control Plane Python Client SDK documentation link in the main SDK reference. - Removed the old Python Runtime SDK API documentation generation script and replaced it with a new one that includes frontmatter. - Added new YAML configuration files for generating API documentation for both the Python Runtime SDK and Control Plane SDK. - Fixed sidebar references for the Python Runtime SDK in the sidebars configuration. - Cleaned up unnecessary commented-out code in the sidebar configuration. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Removes unnecessary 'kubectl apply' wrapper lines in YAML code blocks to streamline documentation and prevent confusion when copying examples. Improves formatting consistency for YAML files, especially around string quoting and indentation in environment variables. Updates wording in a note for deployment mode clarity. Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #497
Closes #501
Closes #500
Closes #499
Closes #498
Proposed Changes
Special Notes
Before merging, We need to update the github pages setting.
Go to: https://github.com/kserve/website/settings/pages
Build and deployment - > Source -> Choose
Github Actions