From 1932a2d23e96e3655945d428db2388649f27ed5f Mon Sep 17 00:00:00 2001 From: Amaury Chamayou Date: Tue, 11 Jan 2022 10:28:53 +0000 Subject: [PATCH] Clean up doc structure (#3359) --- .gitignore | 1 - .prettierignore | 1 - doc/build_apps/build_app.rst | 5 +---- doc/build_apps/index.rst | 16 ---------------- doc/build_apps/install_bin.rst | 7 ++++++- doc/{build_apps => contribute}/build_setup.rst | 0 doc/{build_apps => contribute}/create_vm.rst | 0 doc/contribute/index.rst | 14 +++++++------- 8 files changed, 14 insertions(+), 30 deletions(-) rename doc/{build_apps => contribute}/build_setup.rst (100%) rename doc/{build_apps => contribute}/create_vm.rst (100%) diff --git a/.gitignore b/.gitignore index 89fd58e8868e..e1318997715d 100644 --- a/.gitignore +++ b/.gitignore @@ -18,7 +18,6 @@ doxygen/ obj/ *.retry tests/env/ -getting_started/create_vm/generated sphinx/env/ html/ latex/ diff --git a/.prettierignore b/.prettierignore index cd7c086077f1..436b962631e2 100644 --- a/.prettierignore +++ b/.prettierignore @@ -17,7 +17,6 @@ doxygen/ obj/ *.retry tests/env/ -getting_started/create_vm/generated sphinx/env/ html/ latex/ diff --git a/doc/build_apps/build_app.rst b/doc/build_apps/build_app.rst index 8292fc84b87b..bf4b64560a3e 100644 --- a/doc/build_apps/build_app.rst +++ b/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. diff --git a/doc/build_apps/index.rst b/doc/build_apps/index.rst index f901c956b78b..6e9f7b887bbd 100644 --- a/doc/build_apps/index.rst +++ b/doc/build_apps/index.rst @@ -9,13 +9,6 @@ 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` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -23,13 +16,6 @@ These endpoints can read or mutate the state of a unique :ref:`build_apps/kv/ind --- - :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 diff --git a/doc/build_apps/install_bin.rst b/doc/build_apps/install_bin.rst index ce6afc9b2dd2..55402f19eec6 100644 --- a/doc/build_apps/install_bin.rst +++ b/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`. \ No newline at end of file diff --git a/doc/build_apps/build_setup.rst b/doc/contribute/build_setup.rst similarity index 100% rename from doc/build_apps/build_setup.rst rename to doc/contribute/build_setup.rst diff --git a/doc/build_apps/create_vm.rst b/doc/contribute/create_vm.rst similarity index 100% rename from doc/build_apps/create_vm.rst rename to doc/contribute/create_vm.rst diff --git a/doc/contribute/index.rst b/doc/contribute/index.rst index 37cb1989e2fa..5b2a0ddc261a 100644 --- a/doc/contribute/index.rst +++ b/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