Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Doc] Use shell code-blocks and fix section headers #9508

Merged
merged 3 commits into from
Oct 22, 2024

Conversation

rafvasq
Copy link
Contributor

@rafvasq rafvasq commented Oct 18, 2024

Follow up to #9132, #9256

  • Fixing some wording and formatting
  • Using console instead of shell in code-blocks as listed here.

Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
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.

🚀

Copy link

@ckadner ckadner left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks @rafvasq

@DarkLight1337 DarkLight1337 changed the title Doc: Use shell code-blocks and fix section headers [Doc] Use shell code-blocks and fix section headers Oct 19, 2024
@DarkLight1337
Copy link
Member

Using console instead of shell in code-blocks as listed here.

Actually, I think bash is what you're looking for. console is intended to be used for terminal sections, and thus commands should be prefixed by the user/cwd, e.g. user@abc:~/vllm$

Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
@rafvasq
Copy link
Contributor Author

rafvasq commented Oct 21, 2024

Using console instead of shell in code-blocks as listed here.

Actually, I think bash is what you're looking for. console is intended to be used for terminal sections, and thus commands should be prefixed by the user/cwd, e.g. user@abc:~/vllm$

That's true @DarkLight1337, although in this case these commands are meant to be run in terminal, so I updated the commands to include a prompt symbol $ similar to how they're shown here

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.

LGTM now!

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) October 22, 2024 02:45
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Oct 22, 2024
@DarkLight1337 DarkLight1337 merged commit f7db5f0 into vllm-project:main Oct 22, 2024
50 checks passed
@rafvasq rafvasq deleted the fix-install-doc branch October 23, 2024 15:06
charlifu pushed a commit to charlifu/vllm that referenced this pull request Oct 23, 2024
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Signed-off-by: charlifu <charlifu@amd.com>
vrdn-23 pushed a commit to vrdn-23/vllm that referenced this pull request Oct 23, 2024
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Signed-off-by: Vinay Damodaran <vrdn@hey.com>
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Signed-off-by: Alvant <alvasian@yandex.ru>
MErkinSag pushed a commit to MErkinSag/vllm that referenced this pull request Oct 26, 2024
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Signed-off-by: Erkin Sagiroglu <erkin@infra-aipipeline-1-at1-prox-prod-a.ipa.corp.telnyx.com>
garg-amit pushed a commit to garg-amit/vllm that referenced this pull request Oct 28, 2024
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Signed-off-by: Amit Garg <mitgarg17495@gmail.com>
FerdinandZhong pushed a commit to FerdinandZhong/vllm that referenced this pull request Oct 29, 2024
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Signed-off-by: qishuai <ferdinandzhong@gmail.com>
sumitd2 pushed a commit to sumitd2/vllm that referenced this pull request Nov 14, 2024
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Signed-off-by: Sumit Dubey <sumit.dubey2@ibm.com>
KuntaiDu pushed a commit to KuntaiDu/vllm that referenced this pull request Nov 20, 2024
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
mfournioux pushed a commit to mfournioux/vllm that referenced this pull request Nov 20, 2024
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Signed-off-by: Maxime Fournioux <55544262+mfournioux@users.noreply.github.com>
tlrmchlsmth pushed a commit to neuralmagic/vllm that referenced this pull request Nov 23, 2024
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Signed-off-by: Tyler Michael Smith <tyler@neuralmagic.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants