Merge pull request #53 from liquidz00/docs

Minor documentation updates
macadmins · Aug 2, 2024 · 8705919 · 8705919
2 parents c03929c + 318bc50
commit 8705919
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/docs/contributors/index.rst b/docs/contributors/index.rst
@@ -47,9 +47,9 @@ It is recommended you use a Python virtual environment for local development (se
 
 With your virtual environment active run the following from the SDK repository's directory:
 
-.. code-block:: shell
+.. code-block:: console
 
-    (.vent) % make install
+    (.venv) % make install
 
 This will install the package in editable mode with all dev and optional dependencies.
 

diff --git a/docs/user/getting_started.rst b/docs/user/getting_started.rst
@@ -37,6 +37,11 @@ Import the Jamf Pro client from the SDK:
 
 Create a client object passing in your Jamf Pro server name and a username and password:
 
+.. note::
+
+    When passing your Jamf Pro server name, do not include the scheme (``https://``) as the SDK handles this automatically for you.
+
+
     >>> client = JamfProClient(
     ...     server="jamf.my.org",
     ...     credentials=BasicAuthProvider("oscar", "j@mf1234!")