Merge pull request #24 from ambitus/gh-pages-beta-user-updates

Gh pages beta user updates

Author: ElijahSwiftIBM

_config.yml

@@ -21,7 +21,7 @@ permalink: /:title/
 logo: "/assets/images/logo.png"
 
 # Build settings
-remote_theme: just-the-docs/just-the-docs@main
+remote_theme: just-the-docs/just-the-docs@v0.6.2
 include:
   - contribute.markdown
 color_scheme: dark
@@ -61,6 +61,12 @@ callouts:
   note:
     title: 💡 Note
     color: blue
+  experimental:
+    title: 🚧 Experimental
+    color: red
+  development_status:
+    title: 💻 Development Status
+    color: green
 
 mermaid:
   # Version of mermaid library

access/advanced/add.md

@@ -25,6 +25,13 @@ def add(
 
 #### 📄 Description
 
+ 
+
+{: .experimental }
+> _Only a subset of available **Traits** are considered **Stable**. See [Traits](../segments_traits_operators#traits) for more details._
+
+ 
+
 Create a new **permission**.
 
 #### 📥 Parameters
@@ -65,7 +72,7 @@ traits = {
     "base:access": "READ",
 }
 
-access_admin.add("TESTING", "ELIJTEST", "ESWIFT", traits)
+access_admin.add("TESTING", "ELIJTEST", "ESWIFT", traits=traits)
 ```
 
 ###### Security Result Dictionary as JSON

access/advanced/alter.md

@@ -27,6 +27,11 @@ def alter(
 
  
 
+{: .experimental }
+> _Only a subset of available **Traits** are considered **Stable**. See [Traits](../segments_traits_operators#traits) for more details._
+
+ 
+
 {: .warning }
 > _Alter operations in pyracf require READ access to `IRR.IRRSMO00.PRECHECK` in the `XFACILIT` class_
 > _This function will not produce output unless the user running the command has this access._
@@ -72,7 +77,7 @@ traits = {
     "base:access": "NONE",
 }
 
-access_admin.alter("TESTING", "ELIJTEST", "ESWIFT", traits)
+access_admin.alter("TESTING", "ELIJTEST", "ESWIFT", traits=traits)
 ```
 
 ###### Security Result Dictionary as JSON

access/advanced/segments_traits_operators.md

@@ -6,25 +6,38 @@ parent: Advanced
 
 # Segments, Traits, and Operators
 
-Relevant information about using `segments` dictionaries, `traits` dictionaries, and `operators`.
+Information about permission `segments` dictionaries, `traits` dictionaries, and `operators`.
 {: .fs-6 .fw-300 }
 
 ### Segments
 
  
 
+{: .experimental }
+> _Note that just because a **Segment** is considered **Stable** that does not mean that all of the **Traits** in that **Segment** are considered **Stable**. See [Traits](#traits) for more detail._
+
+ 
+
 {: .warning }
 > _There are no additional segments for **Access** administartion._
 > _Also, note that there is no **Profile Extract** function for **Access** administration. Some access information can be extracted using **[`ResourceAdmin.extract()`](../../../resource/standard/extract#resourceadminextract)** or **[`DataSetAdmin.extract()`](../../../data_set/standard/extract#datasetadminextract)** depending on the type of profile in question._
 
  
 
+| **Segment** | **Description** |
+| `Base` | Describes a permission's **Base** attributes. |
+
 ### Traits
 
  
 
+{: .experimental }
+> _**Traits** that are **NOT** documented below are considered **Experimental**._
+
+ 
+
 {: .note }
-> _All **key-value pair traits** can be set to `False` in **[`AccessAdmin.alter()`](../alter#accessadminalter)** to indicate that they should be removed or unset._
+> _Some **Traits** can be set to `False` to delete their existing values._
 
  
 
@@ -37,7 +50,7 @@ Traits use the following syntax: `<segment>:<trait>`
 &nbsp;
 
 | **Trait** | **Description** | **Valid Types** |
-| `base:access` | Set the **access level** associated with the permission. | Add: `str`<br>Alter: `str` |
+| `base:access` | Set the **access level** associated with the permission. | `str` |
 
 ### Operators
 

assets/css/just-the-docs-default.scss

@@ -130,7 +130,7 @@ a.nav-list-link {
 .nav-list .nav-list-item > .nav-list .nav-list-item > .nav-list .nav-list-item .nav-list-link {
     font-weight: lighter;
     font-size: 12px;
-    text-indent: 15px;
+    padding-left: 47px;
     padding-bottom: 2px;
     padding-top: 2px;
 }
@@ -235,11 +235,43 @@ blockquote.warning code.highlighter-rouge {
     color: #ccc;
 }
 
+blockquote.experimental code.highlighter-rouge {
+    background-color: #545;
+    color: #ccc;
+}
+
 blockquote.note a > code.highlighter-rouge,
 blockquote.warning a > code.highlighter-rouge {
     color: #abf;
 }
 
+blockquote.note::before,
+blockquote.warning::before,
+blockquote.experimental::before {
+    padding-bottom: 0;
+}
+
+blockquote.note > p:first-child,
+blockquote.warning > p:first-child,
+blockquote.experimental > p:first-child {
+    padding-top: .125rem;
+}
+
+blockquote.warning > div.highlighter-rouge code,
+blockquote.warning > div.highlighter-rouge > div.highlight,
+blockquote.warning > div.highlighter-rouge > div.highlight pre {
+    background-color: rgb(95, 85, 50);
+}
+
+blockquote.warning > div.highlighter-rouge > button {
+    background-color: rgb(95, 85, 50);
+    border-color: rgb(95, 85, 50);
+}
+
+.highlight .c1 {
+    color: #0b5
+}
+
 .main-content {
     margin-left: 20px;
 }

common/debug.md

@@ -173,7 +173,7 @@ user_admin.extract("squidwrd")
             {
               "base": {
                 "user": "squidwrd",
-                "name": "unknown",
+                "name": null,
                 "owner": "leonard",
                 "created": "7/12/2023",
                 "defaultGroup": "sys1",
@@ -185,7 +185,7 @@ user_admin.extract("squidwrd")
                 ],
                 "revokeDate": null,
                 "resumeDate": null,
-                "lastAccess": "unknown",
+                "lastAccess": null,
                 "classAuthorizations": [],
                 "logonAllowedDays": "anyday",
                 "logonAllowedTime": "anytime",
@@ -196,7 +196,7 @@ user_admin.extract("squidwrd")
                     "connectDate": "7/12/2023",
                     "connects": 0,
                     "uacc": null,
-                    "lastConnect": "unknown",
+                    "lastConnect": null,
                     "connectAttributes": [],
                     "revokeDate": null,
                     "resumeDate": null

common/replace_existing_segment_traits.md

@@ -10,6 +10,11 @@ Replace existing valid segment traits dictionary.
 
  
 
+{: .experimental }
+> _This functionality is **Experimental** and is subject to major changes and even being removed entirely._
+
+ 
+
 {: .note}
 > _Changes made using the functionality described here are scoped to the target "Admin" object instance._
 

common/update_existing_segment_traits.md

@@ -10,6 +10,11 @@ Update existing valid segment traits dictionary.
 
  
 
+{: .experimental }
+> _This functionality is **Experimental** and is subject to major changes and even being removed entirely._
+
+ 
+
 {: .note}
 > _Changes made using the functionality described here are scoped to the target "Admin" object instance._
 

data_set/advanced/add.md

@@ -19,17 +19,24 @@ def add(
 
 #### 📄 Description
 
-Create a new **data set** profile.
+ 
+
+{: .experimental }
+> _Only a subset of available **Segments** and **Traits** are considered **Stable**. See [Segments](../segments_traits_operators#segments) and [Traits](../segments_traits_operators#traits) for more details._
+
+ 
+
+Create a new **data set profile**.
 
 #### 📥 Parameters
 * `data_set`<br>
-  The name of the **data set** profile being created.
+  The name of the **data set profile** being created.
 
 * `traits`<br>
-  A dictionary of **traits/attributes** that should be given to the data set on creation. See [Traits](../segments_traits_operators#traits) to see what all of the valid **Data Set Traits** are.
+  A dictionary of **traits/attributes** that should be given to the data set profile on creation. See [Traits](../segments_traits_operators#traits) to see what all of the valid **Data Set Traits** are.
 
 * `volume`<br>
-  A single **volume** name for this dataset. This argument is optional. If `generic=True` is specified, volume is ignored.
+  A single **volume** name for this data set profile. This argument is optional. If `generic=True` is specified, volume is ignored.
 
 * `generic`<br>
   A bool indicating whether to treat this profile as **generic** or not. This argument is optional and defaults to `False`.
@@ -44,19 +51,19 @@ Create a new **data set** profile.
 
 #### 💻 Example
 
-The following example **creates** a **new data set** profile called `ESWIFT.TEST.T1136242.P3020470` with two **traits/attributes** as defined in the `traits` dictionary.
+The following example **creates** a **new data set profile** called `ESWIFT.TEST.T1136242.P3020470` with two **traits/attributes** as defined in the `traits` dictionary.
 
 ###### Python Script
 ```python
 from pyracf import DataSetAdmin
-dataset_admin = DataSetAdmin()
+data_set_admin = DataSetAdmin()
 
 traits = {
     "base:universal_access": "None",
     "base:owner": "eswift",
 }
 
-dataset_admin.add("ESWIFT.TEST.T1136242.P3020470", traits=traits)
+data_set_admin.add("ESWIFT.TEST.T1136242.P3020470", traits=traits)
 ```
 
 ###### Security Result Dictionary as JSON
@@ -91,19 +98,19 @@ dataset_admin.add("ESWIFT.TEST.T1136242.P3020470", traits=traits)
 
 #### 💻 Example
 
-The following example **creates** a **new generic data set** profile called `ESWIFT.TEST.**` with two **traits/attributes** as defined in the `traits` dictionary.
+The following example **creates** a **new generic data set profile** called `ESWIFT.TEST.**` with two **traits/attributes** as defined in the `traits` dictionary.
 
 ###### Python Script
 ```python
 from pyracf import DataSetAdmin
-dataset_admin = DataSetAdmin()
+data_set_admin = DataSetAdmin()
 
 traits = {
     "base:universal_access": "None",
     "base:owner": "eswift",
 }
 
-dataset_admin.add("ESWIFT.TEST.**", traits=traits, generic=True)
+data_set_admin.add("ESWIFT.TEST.**", traits=traits, generic=True)
 ```
 
 ###### Security Result Dictionary as JSON

data_set/advanced/alter.md

@@ -22,23 +22,28 @@ def alter(
 
  
 
+{: .experimental }
+> _Only a subset of available **Segments** and **Traits** are considered **Stable**. See [Segments](../segments_traits_operators#segments) and [Traits](../segments_traits_operators#traits) for more details._
+
+ 
+
 {: .warning }
 > _Alter operations in pyracf require READ access to `IRR.IRRSMO00.PRECHECK` in the `XFACILIT` class_
 > _This function will not produce output unless the user running the command has this access._
 
  
 
-Alter an existing **data set** profile.
+Alter an existing **data set profile**.
 
 #### 📥 Parameters
 * `data_set`<br>
-  The name of the **data set** profile being altered.
+  The name of the **data set profile** being altered.
 
 * `traits`<br>
-  A dictionary of **traits/attributes** that should be given to the data set on creation. See [Traits](../segments_traits_operators#traits) to see what all of the valid **Data Set Traits** are.
+  A dictionary of **traits/attributes** that should be given to the data set profile on creation. See [Traits](../segments_traits_operators#traits) to see what all of the valid **Data Set Traits** are.
 
 * `volume`<br>
-  A single **volume** name for this dataset. This argument is optional. If `generic=True` is specified, volume is ignored.
+  A single **volume** name for this data set profile. This argument is optional. If `generic=True` is specified, volume is ignored.
 
 * `generic`<br>
   A bool indicating whether to treat this profile as **generic** or not. This argument is optional and defaults to `False`.
@@ -60,14 +65,14 @@ The following example **alters** a data set profile called `ESWIFT.TEST.T1136242
 
 ```python
 from pyracf import DataSetAdmin
-dataset_admin = DataSetAdmin()
+data_set_admin = DataSetAdmin()
 
 traits = {
     "base:universal_access": "Read",
     "base:owner": "eswift",
 }
 
-dataset_admin.alter("ESWIFT.TEST.T1136242.P3020470", traits=traits)
+data_set_admin.alter("ESWIFT.TEST.T1136242.P3020470", traits=traits)
 ```
 
 ###### Security Result Dictionary as JSON

data_set/advanced/index.md

@@ -8,5 +8,5 @@ has_toc: false
 
 # Advanced
 
-Data Set Administration functions that should be used to perform more complex and nuanced tasks.
+Data Set Profile Administration functions that should be used to perform more complex and nuanced tasks.
 {: .fs-6 .fw-300 }