[doc] Add the FAQ page to track comment issues

vllm-project · Sep 27, 2024 · d7bc5da · d7bc5da
1 parent f9b4c06
commit d7bc5da
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 0 deletions.
diff --git a/docs/source/assets/images/delete-namespace-stuck-1.png b/docs/source/assets/images/delete-namespace-stuck-1.png
diff --git a/docs/source/assets/images/delete-namespace-stuck-2.png b/docs/source/assets/images/delete-namespace-stuck-2.png
diff --git a/docs/source/getting_started/faq.rst b/docs/source/getting_started/faq.rst
@@ -0,0 +1,24 @@
+.. _faq:
+
+===
+FAQ
+===
+
+FAQ - Installation
+------------------
+
+Failed to delete the AIBrix
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. figure:: ../assets/images/delete-namespace-stuck-1.png
+  :alt: aibrix-architecture-v1
+  :width: 70%
+  :align: center
+
+.. figure:: ../assets/images/delete-namespace-stuck-2.png
+  :alt: aibrix-architecture-v1
+  :width: 70%
+  :align: center
+
+In this case, you just need to find the model adapter, edit the object, and remove the ``finalizer`` pair. the pod would be deleted automatically.
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -29,6 +29,7 @@ Documentation
    designs/architecture.rst
    getting_started/quickstart.rst
    getting_started/installation.rst
+   getting_started/faq.rst
 
 .. toctree::
    :maxdepth: 1