diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 24faeeb..07607af 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -8,7 +8,7 @@ Installation * Step 1: Download the main branch from our GitHub page as a zip file, or clone it to your working directory with: - ``git clone https://github.com/jaclark5/kubecustom`` + ``git clone https://github.com/openforcefield/kubecustom`` * Step 2 (Optional): If you are using conda and you want to create a new environment for this package you may install with: diff --git a/docs/index.rst b/docs/index.rst index 70db9c6..3d35a8c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,6 +6,8 @@ Welcome to kubecustom's documentation! ========================================================= +**This is a set of informal tools for internal use. We make no guarantees of versioning, functionality, or support.** + .. grid:: 1 1 2 2 .. grid-item-card:: Getting Started diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 904e778..40374fc 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -5,7 +5,7 @@ Now that your credentials are ready to go (if not see the :ref:`Getting Started` can run the :func:`kubecustom.deployment.utilization_per_deployment` from the command line with a refresh timer: -`python -m kubecustom -h` + ``python -m kubecustom -h`` or check out these examples of how to use in python scripting: