Clean up doc structure (#3359)

.gitignore

@@ -18,7 +18,6 @@ doxygen/
 obj/
 *.retry
 tests/env/
-getting_started/create_vm/generated
 sphinx/env/
 html/
 latex/

.prettierignore

@@ -17,7 +17,6 @@ doxygen/
 obj/
 *.retry
 tests/env/
-getting_started/create_vm/generated
 sphinx/env/
 html/
 latex/

doc/build_apps/build_app.rst

@@ -1,10 +1,7 @@
 Build and Sign CCF Applications
 ===============================
 
-.. note:: Before building a CCF application, make sure that:
-
-    - The CCF development environment has successfully been setup (see :doc:`/build_apps/build_setup`).
-    - CCF is installed (see :doc:`/build_apps/install_bin`).
+.. note:: Before building a CCF application, make sure that CCF is installed (see :doc:`/build_apps/install_bin`).
 
 Once an application is complete, it needs to be built into a shared object, and signed.
 

doc/build_apps/index.rst

@@ -9,27 +9,13 @@ These endpoints can read or mutate the state of a unique :ref:`build_apps/kv/ind
 
 .. panels::
 
-    :fa:`cloud` :doc:`create_vm`
-    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-    Create a SGX-enabled Azure Virtual Machine.
-
-    ---
-
     :fa:`download` :doc:`install_bin`
     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
     Install CCF on Linux.
 
     ---
 
-    :fa:`laptop-code` :doc:`build_setup`
-    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-    Setup CCF environment to build CCF apps.
-
-    ---
-
     .. image:: ../img/cpp.svg
       :width: 22
       :alt: C++
@@ -97,9 +83,7 @@ These endpoints can read or mutate the state of a unique :ref:`build_apps/kv/ind
 .. toctree::
     :hidden:
 
-    create_vm
     install_bin
-    build_setup
     example
     js_app
     build_app

doc/build_apps/install_bin.rst

@@ -61,7 +61,7 @@ The CCF install notably contains:
 
 - The ``cchost`` binary required to spin up a CCF application
 - The ``cmake`` files required to build CCF applications
-- The ``ansible`` playbooks required for :doc:`build_setup` (under ``getting_started/``)
+- The ``ansible`` playbooks required for :doc:`/contribute/build_setup` (under ``getting_started/``)
 - Header files and libraries to build CCF applications (under ``include/`` and ``lib/``)
 - A limited set of Python utilities to start a basic CCF service for local testing
 - Various utility scripts (see :doc:`/build_apps/demo`)
@@ -74,3 +74,8 @@ To remove an installation of CCF, run:
 .. code-block:: bash
 
     $ sudo apt remove ccf
+
+From Source
+-----------
+
+To build and install CCF from source, please see :doc:`/contribute/build_ccf`.

doc/contribute/index.rst

@@ -9,17 +9,17 @@ The CCF team welcome contributions to any part of the framework, including this
 .. panels::
 
 
-    :fa:`cloud` :doc:`/build_apps/create_vm`
-    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    :fa:`cloud` :doc:`create_vm`
+    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
     Create a SGX-enabled Azure Virtual Machine.
 
     ---
 
-    :fa:`laptop-code` :doc:`/build_apps/build_setup`
-    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    :fa:`laptop-code` :doc:`build_setup`
+    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-    Setup CCF environment to CCF from source.
+    Setup CCF environment to build CCF from source.
 
     ---
 
@@ -53,8 +53,8 @@ The CCF team welcome contributions to any part of the framework, including this
     :maxdepth: 1
     :hidden:
 
-    /build_apps/create_vm
-    /build_apps/build_setup
+    create_vm
+    build_setup
     build_ccf
     release_ccf
     design/index