Skip to content

Comments

Docs: Improve index.md with comprehensive feature overview#1412

Open
ChenYi015 wants to merge 1 commit intokubeflow:masterfrom
ChenYi015:doc/update-index
Open

Docs: Improve index.md with comprehensive feature overview#1412
ChenYi015 wants to merge 1 commit intokubeflow:masterfrom
ChenYi015:doc/update-index

Conversation

@ChenYi015
Copy link
Member

Purpose of this PR

This PR significantly improves the main documentation page (docs/index.md) to provide a clearer overview of Arena's capabilities.

Proposed changes

  • Rewrite the main description to better explain Arena's purpose as a CLI for ML workloads on Kubernetes.
  • Add 'Key Features' section with organized subsections:
    • Simplified Training Management (TensorFlow, PyTorch, MPI, Spark, Ray, etc.).
    • Model Serving & Inference (TensorFlow Serving, Triton, KServe, KFServing, etc.).
    • Resource Management (GPU monitoring, node management, auto-scaling).
    • Model Lifecycle (registration, tagging, training/serving integration).
  • Update Platform Support section with current framework list.
  • Add 'Getting Help' section with links to documentation resources.
  • Improve overall documentation structure and readability.

Change Category

  • Documentation update

Rationale

The original index.md had a fragmented structure with unclear organization. This update provides a more modern, scannable documentation format that helps users quickly understand Arena's capabilities.

Signed-off-by: Yi Chen <github@chenyicn.net>
@google-oss-prow
Copy link

[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 ask for approval from chenyi015. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details 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

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant