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

Organise installation documentation into categories and tabs #11935

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

Organise installation documentation into categories and tabs #11935

wants to merge 17 commits into from
+1,200 −391

Conversation

hmellor
Copy link
Collaborator

@hmellor hmellor commented Jan 10, 2025 •
edited by github-actions bot
Loading

Organises the installation documentation into four categories:

  • GPU
  • CPU
  • AI Accelerator
  • OpenVINO (it's kind of it's own thing since it supports devices from multiple other categories)
    image

Within each category, different devices use tabs that switch together:
image

This allows us to share common documentation (i.e. virtual environment setup) between devices without needing to duplicate the content.

@github-actions GitHub Actions
Copy link

👋 Hi! Thank you for contributing to the vLLM project.
Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label Jan 10, 2025
@mergify Mergify
Copy link

mergify bot commented Jan 10, 2025

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @hmellor.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Jan 10, 2025
@hmellor hmellor changed the title Initial commit Organise installation documentation into categories and tabs Jan 10, 2025
@mergify mergify bot removed the needs-rebase label Jan 10, 2025
@hmellor hmellor requested a review from DarkLight1337 January 10, 2025 19:51
@hmellor hmellor marked this pull request as ready for review January 10, 2025 19:51
@hmellor
Copy link
Collaborator Author

hmellor commented Jan 11, 2025

Thanks for the review @DarkLight1337, I'll action your comments on Monday!

@hmellor hmellor force-pushed the group-installation-guides branch from b7869b8 to dd61cb3 Compare January 12, 2025 21:18
@mergify Mergify
Copy link

mergify bot commented Jan 12, 2025

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @hmellor.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Jan 12, 2025
hmellor added 17 commits January 12, 2025 21:28
@hmellor
Initial commit
0d41fd3 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Merge branch 'main' into group-installation-guides
cc06ab3
@hmellor
Extract python env setup so it can be used by all index files
090b662 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Complete CPU merge
b513038 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Match directory naming scheme (- -> _)
cd25045 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Change OpoenVINO title to match others
bfbe5b6 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Complete AI accelerator merging
1a52098 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
codespell
3a89bde 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Fix duplicate labels created by .md files that were in the source a…
373078b 
…nd also included

Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Missed one .inc.md file
4c4ec3e 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Remove extra dependency
a3705e1 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Merge branch 'main' into group-installation-guides
ae99d91 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
pymarkdownlnt fix docs -r
c7349f9 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Respond to comment on GPU supported features
f86e495 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Respond to comment on Apple silicon
c07fede 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Respond to comment on OpenVINO
5c45c16 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
format.sh
64ea29b 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor hmellor force-pushed the group-installation-guides branch from dd61cb3 to 64ea29b Compare January 12, 2025 21:38
@mergify mergify bot removed the needs-rebase label Jan 12, 2025
@hmellor
Copy link
Collaborator Author

hmellor commented Jan 12, 2025

Sorry everyone that got review requested. In trying to satisfy the DCO check the merge from main commits got flattened into my branch and triggered all the code owners to be notified!

@hmellor hmellor requested a review from DarkLight1337 January 12, 2025 21:48
@DarkLight1337
Copy link
Member

Can you also add placeholder tabs in the Extra Information section?

DarkLight1337
DarkLight1337 reviewed Jan 13, 2025
View reviewed changes
docs/source/getting_started/installation/ai_accelerator/index.md
@@ -0,0 +1,357 @@
# AI Accelerator
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# AI Accelerator
# Other AI accelerators

DarkLight1337
DarkLight1337 reviewed Jan 13, 2025
View reviewed changes
Copy link
Member

@DarkLight1337 DarkLight1337 left a comment

Choose a reason for hiding this comment

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

Same for the other pages.

docs/source/getting_started/installation/gpu/index.md

::::

## Python
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Python
## Set up using Python

docs/source/getting_started/installation/gpu/index.md

::::

## Docker
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Docker
## Set up using Docker

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

@DarkLight1337 DarkLight1337 DarkLight1337 left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
ci/build documentation Improvements or additions to documentation frontend
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hmellor @DarkLight1337