diff --git a/docs/source/development-guide/make/development.rst b/docs/source/development-guide/make/development.rst deleted file mode 100644 index e2be118e1..000000000 --- a/docs/source/development-guide/make/development.rst +++ /dev/null @@ -1,10 +0,0 @@ -Development -============ - -**THIS SECTION IS UNDER CONSTRUCTION.** - -If you have questions or would like to help please open an issue on GitHub_. - -.. _GitHub: https://github.com/chaoss/collectoss/issues - -These commands are used to control CollectOSS's backend and frontend servers simultaneously. diff --git a/docs/source/development-guide/make/documentation.rst b/docs/source/development-guide/make/documentation.rst deleted file mode 100644 index dc8ff0c14..000000000 --- a/docs/source/development-guide/make/documentation.rst +++ /dev/null @@ -1,71 +0,0 @@ -Documentation -============= - -**THIS SECTION IS UNDER CONSTRUCTION.** - -If you have questions or would like to help please open an issue on GitHub_. - -.. _GitHub: https://github.com/chaoss/collectoss/issues - -These commands are used to build and view CollectOSS's documentation. -Before making any documentation changes, please read the `documentation guide <../documentation.html>`_. - --------------------------- - -``make docs`` --------------- -Generate both library and API documentation. - -Example\: - -.. code-block:: bash - - $ make docs - --------------------------- - -``make library-docs`` ----------------------- -Generate the library documentation (the documentation you're reading). - -Example\: - -.. code-block:: bash - - $ make library-docs - --------------------------- - -``make library-docs-view`` --------------------------- -Generate the library documentation, and automatically open a new browser tab to view it. - -Example\: - -.. code-block:: bash - - $ make library-docs-view - --------------------------- - -``make api-docs`` ------------------- -Generate the API documentation. - -Example\: - -.. code-block:: bash - - $ make api-docs - --------------------------- - -``make api-docs-view`` ------------------------ -Generate the API documentation, and automatically open a new browser tab to view it. - -Example\: - -.. code-block:: bash - - $ make api-docs-view diff --git a/docs/source/development-guide/make/installation.rst b/docs/source/development-guide/make/installation.rst deleted file mode 100644 index 647ea00f5..000000000 --- a/docs/source/development-guide/make/installation.rst +++ /dev/null @@ -1,74 +0,0 @@ -Installation -============= - -**THIS SECTION IS UNDER CONSTRUCTION.** - -If you have questions or would like to help please open an issue on GitHub_. - -.. _GitHub: https://github.com/chaoss/collectoss/toss/issues - -This section explicitly explains the commands that are used to manage the installation of CollectOSS locally. - ---------------- - -``make install`` ------------------ -This command installs the project dependencies, sets up the default configuration file, and gathers database credentials. - -Example\: - -.. code-block:: bash - - $ make install - ---------------- - -``make install-dev`` ---------------------- -The same as ``make install``, except it installs the additional developer dependencies and installs the packages in editable mode. - -Example\: - -.. code-block:: bash - - $ make install-dev - ---------------- - -``make clean`` ----------------- -Removes logs, caches, and some other cruft that can get annoying. This command is used when things aren't building properly or you think an old version of collectoss is getting in the way. - -Example\: - -.. code-block:: bash - - $ make clean - ---------------- - -``make rebuild`` ----------------- -Used in conjunction with ``make clean`` to remove all build/compiled files and binaries and reinstall the project. Useful for upgrading in place. - -Example\: - -.. code-block:: bash - - $ make rebuild - ---------------- - -``make rebuild-dev`` ---------------------- -The same as ``make rebuild``, except it installs the additional developer dependencies and installs the packages in editable mode. - -.. note:: - - You can still use ``make clean`` as normal if something went wrong. - -Example\: - -.. code-block:: bash - - $ make rebuild-dev diff --git a/docs/source/development-guide/make/testing.rst b/docs/source/development-guide/make/testing.rst deleted file mode 100644 index 05508154e..000000000 --- a/docs/source/development-guide/make/testing.rst +++ /dev/null @@ -1,58 +0,0 @@ -Testing -======= - -**THIS SECTION IS UNDER CONSTRUCTION.** - -If you have questions or would like to help please open an issue on GitHub_. - -.. _GitHub: https://github.com/chaoss/collectoss/issues - -These commands are used to run specific subsets of unit tests. We use ``pytest`` as our test runner. - --------------- - -``make test`` -------------- -This command runs ALL available tests for both the metric functions and their API endpoints. - -Example\: - -.. code-block:: bash - - $ make test - --------------- - -``make test-metrics`` ------------------------- -This command will run ALL unit tests for the metric functions. - -Example\: - -.. code-block:: bash - - $ make test-metrics - --------------- - -``make test-metrics-api`` --------------------------- -The above command runs ALL tests for the metrics API. - -Example\: - -.. code-block:: bash - - $ make test-metrics-api - --------------- - -``pytest`` ----------- -You can also run the tests directly using the ``pytest`` command. - -Example\: - -.. code-block:: bash - - $ uv run pytest diff --git a/docs/source/development-guide/make/toc.rst b/docs/source/development-guide/make/toc.rst deleted file mode 100644 index 75da18238..000000000 --- a/docs/source/development-guide/make/toc.rst +++ /dev/null @@ -1,16 +0,0 @@ -Make commands -=============== - -**THIS SECTION IS UNDER CONSTRUCTION.** - -If you have questions or would like to help please open an issue on GitHub_. - -.. _GitHub: https://github.com/chaoss/collectoss/issues - -.. toctree:: - :maxdepth: 1 - - installation - development - testing - documentation diff --git a/docs/source/development-guide/toc.rst b/docs/source/development-guide/toc.rst index fc447be06..c6b10af1c 100644 --- a/docs/source/development-guide/toc.rst +++ b/docs/source/development-guide/toc.rst @@ -7,7 +7,6 @@ This is the development guide for CollectOSS. See our `Contributing to CollectOS :maxdepth: 1 installation - make/toc logging documentation workers/toc