Docs: structure + updates (#980)

* Docs: structure + updates --------- Co-authored-by: Caleb Johnson <[email protected]>
Qiskit · Oct 3, 2023 · 54c95a4 · 54c95a4
1 parent 32eaec5
commit 54c95a4
Show file tree

Hide file tree

Showing 53 changed files with 942 additions and 1,177 deletions.
diff --git a/Dockerfile-notebook b/Dockerfile-notebook
@@ -24,8 +24,8 @@ RUN rm -r ./qs
 
 WORKDIR /home/$NB_USER
 USER $NB_UID
-COPY --chown=$NB_UID:$NB_UID ./docs/running/notebooks/ ./serverless/running/
-COPY --chown=$NB_UID:$NB_UID ./docs/development/examples/ ./serverless/examples/
-COPY --chown=$NB_UID:$NB_UID ./docs/development/guides/ ./serverless/guides/
+COPY --chown=$NB_UID:$NB_UID ./docs/getting_started/basic/ ./serverless/getting_started/basic/
+COPY --chown=$NB_UID:$NB_UID ./docs/getting_started/experimental/ ./serverless/getting_started/experimental/
+COPY --chown=$NB_UID:$NB_UID ./docs/examples/ ./serverless/examples/
 
 ENV JUPYTER_ENABLE_LAB=no
diff --git a/README.md b/README.md
@@ -72,13 +72,13 @@ For user convenience, this section assumes that users will deploy the infrastruc
 1. Access the JupyterLab environment
    Open `localhost:8888` in your web browser. The default token for the JupyterLab is `123`
 1. Write your first example program
-   In the JupyterLab, create a new file `program.py` in the `serverless/running/source_files/` directory (Note: the directory is inside the containerized environment)
+   In the JupyterLab, create a new file, `program.py`, in the `work` directory.
 
    Save [this example python code](https://qiskit-extensions.github.io/quantum-serverless/quickstart/index.html#id8).  
 
    Now, you are ready to run the first program.
 1. Run the program
-   In the JupyterLab, create a New Notebook and execute [this python code](https://qiskit-extensions.github.io/quantum-serverless/quickstart/index.html#id9).
+   In the JupyterLab, create a new notebook in the same directory as your program, and execute [this python code](https://qiskit-extensions.github.io/quantum-serverless/quickstart/index.html#id9).
 
    You can check the job status and get the result.
 
@@ -97,8 +97,8 @@ For user convenience, this section assumes that users will deploy the infrastruc
    That's all!
    
 For more detailed examples and explanations refer to the [Guide](https://qiskit-extensions.github.io/quantum-serverless/index.html):
+[Getting Started](https://qiskit-extensions.github.io/quantum-serverless/getting_started/index.html#),
 [Deployment](https://qiskit-extensions.github.io/quantum-serverless/deployment/index.html),
-[Running](https://qiskit-extensions.github.io/quantum-serverless/running/index.html#),
 [Development](https://qiskit-extensions.github.io/quantum-serverless/development/index.html).
 
 ----------------------------------------------------------------------------------------------------

diff --git a/docs/conf.py b/docs/conf.py
@@ -8,7 +8,7 @@
 from pathlib import Path
 from importlib.metadata import version as metadata_version
 
-sys.path.append(os.path.abspath('../client'))
+sys.path.append(os.path.abspath("../client"))
 
 project = "Quantum serverless"
 copyright = "2022"  # pylint: disable=redefined-builtin
@@ -58,4 +58,3 @@
 nbsphinx_execute = "never"
 nbsphinx_widgets_path = ""
 exclude_patterns = ["_build", "**.ipynb_checkpoints"]
-
diff --git a/docs/deployment/cloud.rst b/docs/deployment/cloud.rst
@@ -21,11 +21,10 @@ This guide contains:
 Installation requirements
 =========================
 
-To deploy the infrastructure required for ``Quantum Serverless`` you need to have installed three main tools:
+To deploy the infrastructure required for ``Quantum Serverless`` you need to have installed two main tools:
 
 * `Docker <https://www.docker.com/>`_
 * `Helm <https://helm.sh/>`_
-* `Terraform <https://www.terraform.io/>`_
 
 Each of these tools' webpages contain instructions for installing on Windows, MacOS, and Linux.
 
@@ -40,9 +39,7 @@ Once you have these tools installed, you can check the installation by running t
         $
         $ helm version
         $ > version.BuildInfo{Version:"X", GitCommit:"Y", GitTreeState:"Z", GoVersion:"T"}
-        $
-        $ terraform version
-        $ > Terraform X
+
 
 If all the commands return the correct versions, then congratulations, you have the tools installed!
 
@@ -133,56 +130,3 @@ Optionally, you can install an observability package to handle logging and monit
    :caption: run this commands with the release version like 0.6.3 in x.y.z (2 places) using the same namespace as in the previous helm command
 
         $ helm -n <INSERT_YOUR_NAMESPACE> install qs-observability  https://github.com/Qiskit-Extensions/quantum-serverless/releases/download/vx.y.z/qs-observability-x.y.z.tgz
-
-.. _terraform-deployment:
-
-Quantum Serverless configuration
-==================================
-
-Once your resources are deployed, we can configure the Quantum Serverless ``client`` package.
-There are a couple of simple ways to do this.
-
-One option is to pass the configuration as arguments to the constructor of a ``QuantumServerless`` instance:
-
-.. code-block::
-    :caption: constructor arguments example
-
-        serverless = QuantumServerless({
-            "providers": [{
-                "name": "my_provider",  # provider name
-                "compute_resource": { # main computational resource
-                    "name": "my_resource", # cluster name
-                    "host": "HOST_ADDRESS_OF_CLUSTER_HEAD_NODE", # cluster host address, if you are using helm it will be DEPLOYMENT_NAME-kuberay-head-svc
-                }
-            }]
-        })
-
-Another option is to create an instance from a configuration file, which has exactly the same structure as the constructor argument in the above example.
-
-.. code-block::
-    :caption: config.json example
-
-        {
-            "providers": [{
-                "name": "my_provider",
-                "compute_resource": {
-                    "name": "my_cluster",
-                    "host": "HOST_ADDRESS_OF_CLUSTER_HEAD_NODE",
-                }
-            }]
-        }
-
-Instantiate the ``QuantumServerless`` instance from the configuration file:
-
-.. code-block::
-    :caption: verify the name and the path to load the file
-
-        serverless = QuantumServerless.load_configuration("./config.json")
-
-And use it as follows:
-
-.. code-block::
-    :caption: remember to use the same provider name
-
-        with serverless.provider("my_provider"):
-        ...
diff --git a/docs/development/examples/07_benchmark_program.ipynb b/docs/development/examples/07_benchmark_program.ipynb
diff --git a/docs/development/examples/images/benchmark_flow.png b/docs/development/examples/images/benchmark_flow.png
diff --git a/docs/development/examples/images/diagram_get.png b/docs/development/examples/images/diagram_get.png
diff --git a/docs/development/examples/images/diagrams_compute_resource.png b/docs/development/examples/images/diagrams_compute_resource.png
diff --git a/docs/development/examples/images/diagrams_context_management.png b/docs/development/examples/images/diagrams_context_management.png
diff --git a/docs/development/examples/images/diagrams_function.png b/docs/development/examples/images/diagrams_function.png
diff --git a/docs/development/examples/images/diagrams_infra.png b/docs/development/examples/images/diagrams_infra.png
diff --git a/docs/development/examples/images/diagrams_put.png b/docs/development/examples/images/diagrams_put.png
diff --git a/docs/development/examples/images/diagrams_resource_allocation.png b/docs/development/examples/images/diagrams_resource_allocation.png
diff --git a/docs/development/examples/images/electronic_structure_problem.png b/docs/development/examples/images/electronic_structure_problem.png
diff --git a/docs/development/examples/images/qr_demo1.png b/docs/development/examples/images/qr_demo1.png
diff --git a/docs/development/examples/images/qr_docs.png b/docs/development/examples/images/qr_docs.png
diff --git a/docs/development/examples/images/qr_repo.png b/docs/development/examples/images/qr_repo.png
diff --git a/docs/development/examples/serverless_config.json b/docs/development/examples/serverless_config.json