[Doc] Move CONTRIBUTING to docs site (vllm-project#9924)

Signed-off-by: Russell Bryant <[email protected]> Signed-off-by: Sumit Dubey <[email protected]>
sumitd2 · Nov 14, 2024 · 451081a · 451081a
1 parent 71a9e6b
commit 451081a
Show file tree

Hide file tree

Showing 10 changed files with 100 additions and 68 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,60 +1,3 @@
 # Contributing to vLLM
 
-Thank you for your interest in contributing to vLLM! Our community is open to everyone and welcomes all kinds of contributions, no matter how small or large. There are several ways you can contribute to the project:
-
-- Identify and report any issues or bugs.
-- Request or add support for a new model.
-- Suggest or implement new features.
-- Improve documentation or contribute a how-to guide. 
-
-We also believe in the power of community support; thus, answering queries, offering PR reviews, and assisting others are also highly regarded and beneficial contributions.
-
-Finally, one of the most impactful ways to support us is by raising awareness about vLLM. Talk about it in your blog posts and highlight how it's driving your incredible projects. Express your support on social media if you're using vLLM, or simply offer your appreciation by starring our repository!
-
-## License
-
-See [LICENSE](LICENSE).
-
-## Developing
-
-Depending on the kind of development you'd like to do (e.g. Python, CUDA), you can choose to build vLLM with or without compilation. Check out the [building from source](https://docs.vllm.ai/en/latest/getting_started/installation.html#build-from-source) documentation for details.
-
-## Testing
-
-```bash
-pip install -r requirements-dev.txt
-
-# linting and formatting
-bash format.sh
-# Static type checking
-mypy
-# Unit tests
-pytest tests/
-```
-**Note:** Currently, the repository does not pass the ``mypy`` tests.
-
-## Contribution Guidelines
-
-### DCO and Signed-off-by
-
-When contributing changes to this project, you must agree to the [DCO](DCO).
-Commits must include a `Signed-off-by:` header which certifies agreement with
-the terms of the [DCO](DCO).
-
-Using `-s` with `git commit` will automatically add this header.
-
-### Issues
-
-If you encounter a bug or have a feature request, please [search existing issues](https://github.com/vllm-project/vllm/issues?q=is%3Aissue) first to see if it has already been reported. If not, please [file a new issue](https://github.com/vllm-project/vllm/issues/new/choose), providing as much relevant information as possible.
-
-> [!IMPORTANT]
-> If you discover a security vulnerability, please follow the instructions [here](/SECURITY.md#reporting-a-vulnerability).
-
-### Pull Requests & Code Reviews
-
-Please check the PR checklist in the [PR template](.github/PULL_REQUEST_TEMPLATE.md) for detailed guide for contribution.
-
-### Thank You
-
-Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM.
-All of your contributions help make vLLM a great tool and community for everyone!
+You may find information about contributing to vLLM on [docs.vllm.ai](https://docs.vllm.ai/en/latest/contributing/overview/).
diff --git a/docs/source/dev/dockerfile/dockerfile.rst → ...ce/contributing/dockerfile/dockerfile.rst b/docs/source/dev/dockerfile/dockerfile.rst → ...ce/contributing/dockerfile/dockerfile.rst
diff --git a/docs/source/contributing/overview.rst b/docs/source/contributing/overview.rst
@@ -0,0 +1,70 @@
+Contributing to vLLM
+=====================
+
+Thank you for your interest in contributing to vLLM! Our community is open to everyone and welcomes all kinds of contributions, no matter how small or large. There are several ways you can contribute to the project:
+
+- Identify and report any issues or bugs.
+- Request or add support for a new model.
+- Suggest or implement new features.
+- Improve documentation or contribute a how-to guide.
+
+We also believe in the power of community support; thus, answering queries, offering PR reviews, and assisting others are also highly regarded and beneficial contributions.
+
+Finally, one of the most impactful ways to support us is by raising awareness about vLLM. Talk about it in your blog posts and highlight how it's driving your incredible projects. Express your support on social media if you're using vLLM, or simply offer your appreciation by starring our repository!
+
+License
+-------
+
+See `LICENSE <https://github.com/vllm-project/vllm/tree/main/LICENSE>`_.
+
+Developing
+----------
+
+Depending on the kind of development you'd like to do (e.g. Python, CUDA), you can choose to build vLLM with or without compilation. Check out the `building from source <https://docs.vllm.ai/en/latest/getting_started/installation.html#build-from-source>`_ documentation for details.
+
+Testing
+-------
+
+.. code-block:: bash
+
+    pip install -r requirements-dev.txt
+
+    # linting and formatting
+    bash format.sh
+    # Static type checking
+    mypy
+    # Unit tests
+    pytest tests/
+
+.. note:: Currently, the repository does not pass the ``mypy`` tests.
+
+Contribution Guidelines
+=======================
+
+DCO and Signed-off-by
+----------------------
+
+When contributing changes to this project, you must agree to the `DCO <https://github.com/vllm-project/vllm/tree/main/DCO>`_.
+Commits must include a ``Signed-off-by:`` header which certifies agreement with
+the terms of the `DCO <https://github.com/vllm-project/vllm/tree/main/DCO>`_.
+
+Using ``-s`` with ``git commit`` will automatically add this header.
+
+Issues
+------
+
+If you encounter a bug or have a feature request, please `search existing issues <https://github.com/vllm-project/vllm/issues?q=is%3Aissue>`_ first to see if it has already been reported. If not, please `file a new issue <https://github.com/vllm-project/vllm/issues/new/choose>`_, providing as much relevant information as possible.
+
+.. important::
+   If you discover a security vulnerability, please follow the instructions `here <https://github.com/vllm-project/vllm/tree/main/SECURITY.md#reporting-a-vulnerability>`_.
+
+Pull Requests & Code Reviews
+----------------------------
+
+Please check the PR checklist in the `PR template <https://github.com/vllm-project/vllm/tree/main/.github/PULL_REQUEST_TEMPLATE.md>`_ for a detailed guide for contribution.
+
+Thank You
+---------
+
+Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM.
+All of your contributions help make vLLM a great tool and community for everyone!
diff --git a/.../source/dev/profiling/profiling_index.rst → ...ontributing/profiling/profiling_index.rst b/.../source/dev/profiling/profiling_index.rst → ...ontributing/profiling/profiling_index.rst
diff --git a/..._processing/input_processing_pipeline.rst → ..._processing/input_processing_pipeline.rst b/..._processing/input_processing_pipeline.rst → ..._processing/input_processing_pipeline.rst
diff --git a/...v/input_processing/model_inputs_index.rst → ...n/input_processing/model_inputs_index.rst b/...v/input_processing/model_inputs_index.rst → ...n/input_processing/model_inputs_index.rst
diff --git a/docs/source/dev/kernel/paged_attention.rst → .../source/design/kernel/paged_attention.rst b/docs/source/dev/kernel/paged_attention.rst → .../source/design/kernel/paged_attention.rst
diff --git a/...v/multimodal/adding_multimodal_plugin.rst → ...n/multimodal/adding_multimodal_plugin.rst b/...v/multimodal/adding_multimodal_plugin.rst → ...n/multimodal/adding_multimodal_plugin.rst
diff --git a/...ource/dev/multimodal/multimodal_index.rst → ...ce/design/multimodal/multimodal_index.rst b/...ource/dev/multimodal/multimodal_index.rst → ...ce/design/multimodal/multimodal_index.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -130,26 +130,45 @@ Documentation
 
    performance/benchmarks
 
+.. Community: User community resources
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Community
+
+   community/meetups
+   community/sponsors
+
+.. API Documentation: API reference aimed at vllm library usage
+
 .. toctree::
    :maxdepth: 2
-   :caption: Developer Documentation
+   :caption: API Documentation
 
    dev/sampling_params
    dev/pooling_params
    dev/offline_inference/offline_index
    dev/engine/engine_index
-   dev/kernel/paged_attention
-   dev/input_processing/model_inputs_index
-   dev/multimodal/multimodal_index
-   dev/dockerfile/dockerfile
-   dev/profiling/profiling_index
+
+.. Design: docs about vLLM internals
 
 .. toctree::
-   :maxdepth: 1
-   :caption: Community
+   :maxdepth: 2
+   :caption: Design
 
-   community/meetups
-   community/sponsors
+   design/input_processing/model_inputs_index
+   design/kernel/paged_attention
+   design/multimodal/multimodal_index
+
+.. Contributing: contributing to the vLLM project
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contributing
+
+   contributing/overview
+   contributing/profiling/profiling_index
+   contributing/dockerfile/dockerfile
 
 Indices and tables
 ==================