From f27aff49dad53b9fa10805e914b60db5db83a9da Mon Sep 17 00:00:00 2001
From: bearomorphism <yutingh@synology.com>
Date: Thu, 14 Nov 2024 05:40:45 +0800
Subject: [PATCH] docs(contribute): rewrite flyte contribute docs based on 4960
 (#5260)

* docs(contribute): rewrite flyte contribute docs based on 4960

Signed-off-by: Yu-Ting Hsiung <bear890707@gmail.com>

* docs(contribute): add conda setup back as an alternative

---------

Signed-off-by: Yu-Ting Hsiung <bear890707@gmail.com>
---
 docs/community/contribute/contribute_code.rst | 34 ++++++++++++++++---
 1 file changed, 30 insertions(+), 4 deletions(-)

diff --git a/docs/community/contribute/contribute_code.rst b/docs/community/contribute/contribute_code.rst
index c0cae7dade..c0fe3294aa 100644
--- a/docs/community/contribute/contribute_code.rst
+++ b/docs/community/contribute/contribute_code.rst
@@ -25,12 +25,38 @@ To understand how the below components interact with each other, refer to :ref:`
     * - **Purpose**: Deployment, Documentation, and Issues
     * - **Languages**: RST
 
-To build the Flyte docs locally you will need the following prerequisites:
+In the ``flyteorg/flyte`` root directory you can run ``make dev-docs`` to build the documentation locally. The generated documentation will be in the ``docs/_build/html`` directory.
 
+**Setup process**
+
+1. First you need to make sure you can run linux/amd64 container
+2. Run the following commands to build the documentation and serve it locally
+
+.. prompt:: bash $
+
+ make dev-docs
+ python -m http.server --directory docs/_build/html
+
+3. Go to http://localhost:8000 to see the documentation.
+
+**Supported environment variables of** ``make dev-docs``
+
+* ``DEV_DOCS_WATCH``: If set, the docs will be built and served using `sphinx-autobuild <https://github.com/sphinx-doc/sphinx-autobuild>`__ for live updates.
+* ``FLYTEKIT_LOCAL_PATH``: If set, the local path to flytekit will be used instead of the source code from the ``flyteorg/flytekit repo``.
+* ``FLYTECTL_LOCAL_PATH``: If set, the local path to flytectl will be used instead of the source code from the ``flyteorg/flytectl repo``.
+* ``FLYTESNACKS_LOCAL_PATH``: If set, the local path to flytesnacks will be used instead of the source code from the ``flyteorg/flytesnacks`` repo.
+
+For example, to use the local flytekit source code instead of the source code from the ``flyteorg/flytekit`` repo, run ``export FLYTEKIT_LOCAL_PATH=/path/to/flytekit`` before running ``make dev-docs``.
+
+**Alternative conda setup steps**
+
+* Install ``conda``.
+    *  We recommend Miniconda installed with an `official installer <https://docs.conda.io/projects/miniconda/en/latest/index.html#latest-miniconda-installer-links>`__.
 * Install `conda-lock <https://github.com/conda/conda-lock>`__.
-* In the ``flyteorg/flyte`` root directory you can run:
-    * ``make dev-docs`` to build the documentation locally. The build will be in the ``docs/_build/html`` directory. See `the script <https://github.com/flyteorg/flyte/blob/master/script/local_build_docs.sh>`__ for additional environment variables that can be set.
-        * For example, to use the local flytekit source code instead of the source code from the flyteorg/flytekit repo, run ``export FLYTEKIT_LOCAL_PATH=/path/to/flytekit`` before running ``make dev-docs``.
+* In the ``flyteorg/flyte`` root directory run:
+    * ``conda-lock install --name monodocs-env monodocs-environment.lock.yaml``
+    * ``conda activate monodocs-env``
+    * ``pip install ./flyteidl``
 
 ``flyteidl``
 ************