From 0b5a9643fd6c3240d7ede669e37209d7ff433841 Mon Sep 17 00:00:00 2001 From: Zhenyu Zheng Date: Wed, 26 Mar 2025 16:25:57 +0800 Subject: [PATCH] Add an example for user stories (#399) Add an example for user stories and fix some typo Add a new section, user story in the docs, to collect user stories of llvm-ascend, also add an example and the issue template to collect user story Signed-off-by: Zhenyu Zheng --- .github/ISSUE_TEMPLATE/110-user-story.yml | 50 +++++++++++++++++++++++ docs/README.md | 2 +- docs/source/index.md | 11 ++++- docs/source/user_stories/example.md | 15 +++++++ docs/source/user_stories/index.md | 22 ++++++++++ 5 files changed, 97 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/110-user-story.yml create mode 100644 docs/source/user_stories/example.md create mode 100644 docs/source/user_stories/index.md diff --git a/.github/ISSUE_TEMPLATE/110-user-story.yml b/.github/ISSUE_TEMPLATE/110-user-story.yml new file mode 100644 index 0000000..2c80b6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/110-user-story.yml @@ -0,0 +1,50 @@ +name: 📚 User Story +description: Apply for an user story to be displayed on https://vllm-ascend.readthedocs.org/user_stories/index.html +title: "[User Story]: " +labels: ["user-story"] + +body: +- type: textarea + attributes: + label: 📚 Title + description: > + A clear title about what your story is about. + A clear and concise description of what content in https://vllm-ascend.readthedocs.org/ is an issue. + validations: + required: true +- type: textarea + attributes: + label: About / Introduction + description: > + A brief introduction about the background of your use case, like your scenario, hardware size etc. + Tell us how we could improve the documentation in this regard. +- type: textarea + attributes: + label: About / Introduction + description: > + A brief introduction about the background of your use case, like your scenario, hardware size etc. + Tell us how we could improve the documentation in this regard. +- type: textarea + attributes: + label: Bussiness Challenges + description: > + Tell us how what kind of challenge you faced in this user story. +- type: textarea + attributes: + label: Solving challenges with vLLM Ascend + description: > + Tell us how vLLM Ascend helped you overcome the challenges, including details like how you use it, what version you used, hardware info, etc. +- type: textarea + attributes: + label: Benefits using vLLM Ascend + description: > + Tell us the benefits about using vLLM Ascend +- type: textarea + attributes: + label: Extra Info + description: > + Any extra infomation you want to include in this story +- type: markdown + attributes: + value: > + Thanks for contributing 🎉! \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index afdd0fd..1e4de2b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,7 +16,7 @@ make html ## Open the docs with your browser ```bash -python -m http.server -d build/html/ +python -m http.server -d _build/html/ ``` Launch your browser and open http://localhost:8000/. diff --git a/docs/source/index.md b/docs/source/index.md index 0dee999..6e4381f 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -48,10 +48,17 @@ user_guide/supported_models user_guide/release_notes ::: -% How to contribute to the vLLM project +% How to contribute to the vLLM Ascend project :::{toctree} :caption: Developer Guide :maxdepth: 1 developer_guide/contributing developer_guide/versioning_policy -::: \ No newline at end of file +::: + +% User stories about vLLM Ascend project +:::{toctree} +:caption: User Story +:maxdepth: 1 +user_stories/index +::: diff --git a/docs/source/user_stories/example.md b/docs/source/user_stories/example.md new file mode 100644 index 0000000..ebbcf56 --- /dev/null +++ b/docs/source/user_stories/example.md @@ -0,0 +1,15 @@ +# xxx project uses Ascend vLLM, gain 200% performance enhancement of inference. + +## About / Introduction +Draft content + +## The Business Challenge +Our goal is to ... + +## Solving challenges with vLLM Ascend +vLLM Ascend helped us ... + +## Benefits using vLLM Ascend + +## Learn more +more info about this case diff --git a/docs/source/user_stories/index.md b/docs/source/user_stories/index.md new file mode 100644 index 0000000..6de8b21 --- /dev/null +++ b/docs/source/user_stories/index.md @@ -0,0 +1,22 @@ +# vLLM Ascend User Stories + +Read case studies on how users and developers solves real, everyday problems with vLLM Ascend + +:::{card} Example user story +:link: ./example +:link-type: doc + +xxx project uses Ascend vLLM, gain 200% performance enhancement of inference. + ++++ + +**Tags**: vLLM, Ascend, Inference + +::: + +:::{toctree} +:caption: Deployment +:maxdepth: 1 +:hidden: +example +:::