Fix doc typo (#12)

* Fix doc typo * Enhance documentation * Enhance documentation
QubitPi · Apr 23, 2024 · 4debba5 · 4debba5
1 parent 758f4c4
commit 4debba5
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -7,17 +7,22 @@ Screwdriver CD Python SDK
 [![GitHub Workflow Status][GitHub Workflow Status badge]][GitHub Workflow Status URL]
 [![Apache License badge]][Apache License URL]
 
-Documentation
--------------
+Screwdriver CD Python SDK offers a programmatic approach of interacting with
+[Screwdriver API](https://qubitpi.github.io/screwdriver-cd-guide/user-guide/api). For example, it supports
 
-Coming soon
+- [Batch creating pipeline jobs](https://screwdriver-cd-python-sdk.readthedocs.io/en/latest/sdk.html#screwdriver_cd_python_sdk.screwdriver_initializer.initialize)
+- [Searching pipeline by name](https://screwdriver-cd-python-sdk.readthedocs.io/en/latest/sdk.html#screwdriver_cd_python_sdk.screwdriver_initializer.initialize)
+- [Trigger a pipeline build](https://screwdriver-cd-python-sdk.readthedocs.io/en/latest/sdk.html#screwdriver_cd_python_sdk.screwdriver_initializer.initialize)
+- etc.
 
-Troubleshooting
----------------
+To install the SDK, simply run
 
-### PyCharm Doesn't Detect Newly Installed screwdriver-cd-python-sdk
+```console
+pip install screwdriver-cd-python-sdk
+```
 
-Simply close your project and open it with PyCharm again. The re-indexing should make it work
+Please visit [Screwdriver CD Python SDK documentation](https://screwdriver-cd-python-sdk.readthedocs.io/en/latest/) for
+more details
 
 License
 -------

diff --git a/docs/source/faq.rst b/docs/source/faq.rst
@@ -76,3 +76,9 @@ No module named 'pytest' while Running Test Directly in PyCharm
 
 The solution is going to '**Settings** -> **Tools** -> **Python Integrated Tools**' and scroll down to where it says
 `pytest not found` and there is a **FIX** button. Clicking on it and apply the settings shall resolve the problem
+
+
+PyCharm Doesn't Detect Newly Installed screwdriver-cd-python-sdk
+================================================================
+
+Simply close your project and open it with PyCharm again. The re-indexing should make it work
diff --git a/screwdriver_cd_python_sdk/pipeline.py b/screwdriver_cd_python_sdk/pipeline.py
@@ -103,7 +103,8 @@ def create_pipeline(checkout_url: str, screwdriver_api_url: str, token: str, sou
     :param screwdriver_api_url:  The URL of the Screwdriver API server
     :param token:  The Screwdriver API token
     :param source_directory:  The custom directory that this pipeline is based upon. See
-    https://qubitpi.github.io/screwdriver-cd-guide/user-guide/configuration/sourceDirectory for more details
+    `Source Directory <https://qubitpi.github.io/screwdriver-cd-guide/user-guide/configuration/sourceDirectory>`_
+     for more details
 
     :return: the native API response body object with the following fields:
 

diff --git a/screwdriver_cd_python_sdk/screwdriver_initializer.py b/screwdriver_cd_python_sdk/screwdriver_initializer.py
@@ -55,7 +55,7 @@ def initialize(pipelines_config_path: str, screwdriver_api_url: str, token: str)
         ]
 
     In addition, one can also preload
-    `GitHub Secrets <https://screwdriver-docs.qubitpi.org/user-guide/configuration/secrets>`_ with, for example
+    `Screwdriver Secrets <https://screwdriver-docs.qubitpi.org/user-guide/configuration/secrets>`_ with, for example
 
     .. highlight:: json
     .. code-block:: json