chore: add npm scripts to help remember build steps

Signed-off-by: Fernando Rijo Cedeno <[email protected]>
zowe · Dec 11, 2024 · 7de93d0 · 7de93d0
1 parent 014dae6
commit 7de93d0
Show file tree

Hide file tree

Showing 7 changed files with 618 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -180,3 +180,5 @@ docs/source/classes
 # Team config files
 zowe.config*.json
 zowe.schema.json
+
+node_modules/
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,8 +9,8 @@ Python developers can leverage the Zowe SDK in order to create powerful scripts/
    :maxdepth: 2
    :caption: Contents:
 
-   usage/getting-started
    about/about
+   usage/getting-started
    packages/packages
    classes/index
    contributing/contributing
diff --git a/docs/source/usage/advanced.rst b/docs/source/usage/advanced.rst
@@ -0,0 +1,5 @@
+Advanced usage
+===============
+
+- You can use a custom Certificate Authority.
+   The python SDK supports the commonly used environmental variables `REQUESTS_CA_BUNDLE` and `CURL_CA_BUNDLE` to provide a certificate chain. Also, you may use the `SSL_CERT_FILE` environmental variable.
diff --git a/docs/source/usage/getting-started.rst b/docs/source/usage/getting-started.rst
@@ -4,11 +4,7 @@ Getting started
 .. toctree::
    :maxdepth: 2
 
+   requirements
    installation
    examples
-
-Tips
-----
-
-- You can use a custom Certificate Authority.
-   The python SDK supports the commonly used environmental variables `REQUESTS_CA_BUNDLE` and `CURL_CA_BUNDLE` to provide a certificate chain. Also, you may use the `SSL_CERT_FILE` environmental variable.
+   advanced
diff --git a/docs/source/usage/requirements.rst b/docs/source/usage/requirements.rst
@@ -0,0 +1,8 @@
+Requirements
+=============
+
+The project requires the following:
+
+- Python 3.9 and above
+- Sphinx (optional - To build project documentation)
+- Enchant (optional - to build project documentation)