Docs css and link updates (#93)

conceptualshark · NevilleS · web-flow · commit bbbb34d7a8e3 · 2023-01-16T21:35:43.000-05:00
* DOX-180 update user contact taxonomy

* pre-2.0 docs unification

* missed docs

* css fixes for mobile

* link color

* Incorporate review comments

Co-authored-by: Neville Samuell &lt;neville@ethyca.com&gt;
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,5 +1,5 @@
 ## Fides Code of Conduct
 
-The Fides project, which includes Fideslang, Fidesops, and Fidesctl, adheres to the following [Code of Conduct](https://ethyca.github.io/fides/community/code_of_conduct/).
+The Fides project, which includes Fideslang, adheres to the following [Code of Conduct](https://ethyca.github.io/fides/community/code_of_conduct/).
 
 The Fides core team welcomes any contributions and suggestions to help make the community a better place 🤝
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,5 +1,5 @@
 ## Fides Contribution Guidelines
 
-The Fides project, which includes Fideslang, Fidesops, and Fidesctl, adheres to the following [Contribution Guidelines](https://ethyca.github.io/fides/development/overview/).
+The Fides project, which includes Fideslang, adheres to the following [Contribution Guidelines](https://ethyca.github.io/fides/development/overview/).
 
 The Fides core team welcomes any contributions and suggestions to help make the community a better place 🤝
diff --git a/mkdocs/docs/css/fides.css b/mkdocs/docs/css/fides.css
@@ -3,11 +3,13 @@
 [data-md-color-scheme="default"] {
     --md-typeset-color: rgb(66, 84, 102);
     --md-default-fg-color--light: rgb(17, 20, 57);
-    --md-primary-fg-color: #8653f2;
+    --md-primary-fg-color: #1A1D2E;
+    --md-primary-fg-color--dark: #1A1D2E;
     --md-vis-bg-color: rgba(0, 0, 0, 0.02);
     --md-code-bg-color: #8653f227;
     --md-code-fg-color: #6536EC;
     --md-accent-fg-color: #6536EC;
+    --md-typeset-a-color: #6536EC;
     --md-code-hl-number-color: rgb(240, 96, 144);
     --md-code-hl-name-color: rgb(163, 171, 216);
     --md-nav-border: #ccc;
@@ -38,6 +40,7 @@
     --md-default-fg-color--light: rgb(247, 250, 252);
     --md-default-bg-color: #2A2F45;
     --md-primary-fg-color: #1A1D2E;
+    --md-primary-fg-color--dark: #1A1D2E;
     --md-accent-fg-color: #0cc876;
     --md-typeset-a-color: rgb(31, 223, 143);
     --md-vis-bg-color: rgba(0, 0, 0, 0.12);
@@ -62,6 +65,10 @@ body {
     background-color: var(--md-header-bg-color);
 }
 
+.md-tabs {
+    background-color: var(--md-header-bg-color);
+}
+
 .md-header .md-logo img {
     width: 100px;
     height: auto;
@@ -454,3 +461,18 @@ form.hs-form{
         margin-left: 10px;
     }
 }
+
+.admonition code, .admonition-title code {
+    font-size: .85em;
+}
+
+.md-typeset table:not([class]) code {
+    font-size: .60rem;
+}
+
+@media screen and (max-width: 76.1875em) {
+    .md-nav--primary .md-nav__title {
+        background-color: var(--md-primary-fg-color);
+        color: var(--md-primary-bg-color);
+    }
+}
diff --git a/mkdocs/docs/csv/data_categories.csv b/mkdocs/docs/csv/data_categories.csv
@@ -20,13 +20,14 @@ user.device.cookie_id,Cookie ID,user.device,Cookie unique identification number.
 user.device.device_id,Device ID,user.device,Device unique identification number.
 user.device.ip_address,IP Address,user.device,Unique identifier related to device connection.
 user.contact,Contact Data,user,User contact data for purposes other than account management.
-user.contact.city,User Contact City,user.contact,"User's city level address data."
-user.contact.country,User Contact Country,user.contact,"User's country level address data."
 user.contact.email,User Contact Email,user.contact,"User's email address."
 user.contact.phone_number,User Contact Phone Number,user.contact,"User's phone number."
-user.contact.postal_code,User Contact Postal Code,user.contact,"User's postal code."
-user.contact.state,User Contact State,user.contact,"User's state level address data."
-user.contact.street,User Contact Street,user.contact,"User's street level address data."
+user.contact.address,Address Data,user.contact,User contact data related to an address.
+user.contact.address.city,User Contact City,user.contact.address,"User's city level address data."
+user.contact.address.country,User Contact Country,user.contact.address,"User's country level address data."
+user.contact.address.postal_code,User Contact Postal Code,user.contact.address,"User's postal code."
+user.contact.address.state,User Contact State,user.contact.address,"User's state level address data."
+user.contact.address.street,User Contact Street,user.contact.address,"User's street level address data."
 user.credentials,Credentials,user,User authentication data.
 user.credentials.biometric_credentials,Biometric Credentials,user.credentials,Credentials for system authentication.
 user.credentials.password,Password,user.credentials,Password for system authentication.
diff --git a/mkdocs/docs/overview.md b/mkdocs/docs/overview.md
@@ -1,6 +1,6 @@
 # Fides Language Documentation
 
-This is the documentation for Fides' configuration language. It is relevant to users of **Fides Control** ([`fidesctl`](https://github.com/ethyca/fides/)), **Fides Ops** ([`fidesops`](https://github.com/ethyca/fidesops/), and other privacy tools that are in the roadmap.
+This is the documentation for Fides' configuration language. It is relevant to users of [**Fides**](https://github.com/ethyca/fides/) and other privacy tools that are in the roadmap.
 
 The Fides language is Fides' primary user interface. In every use of Fides, configuration files written in the Fides language is always at the heart of the workflow.
 
@@ -27,4 +27,4 @@ A System declaration in Fides language represents the privacy properties of a si
 
 ### Policy YAML
 
-A Policy declaration in Fides language represents a set of rules for privacy or compliance that the system must adhere to. The `fidesctl` tool evaluates these policies against the system & dataset declarations to ensure automated compliance.
+A Policy declaration in Fides language represents a set of rules for privacy or compliance that the system must adhere to. Fides CLI tools evaluates these policies against the system and dataset declarations to ensure automated compliance.
diff --git a/mkdocs/docs/resources/policy.md b/mkdocs/docs/resources/policy.md
@@ -79,7 +79,7 @@ policy:
         data_qualifier: aggregated.anonymized.unlinked_pseudonymized.pseudonymized.identified
 ```
 
-**Demo manifest file:** `/fides/fidesctl/demo_resources/demo_policy.yml`
+**Demo manifest file:** `/fides/demo_resources/demo_policy.yml`
 
 ### **API Payload**
 
diff --git a/mkdocs/docs/resources/system.md b/mkdocs/docs/resources/system.md
@@ -121,7 +121,7 @@ system:
           - yet_another_demo_system
 ```
 
-**Demo manifest file:** `/fides/fidesctl/demo_resources/demo_system.yml`
+**Demo manifest file:** `/fides/demo_resources/demo_system.yml`
 
 ### **API**
 
diff --git a/mkdocs/docs/syntax.md b/mkdocs/docs/syntax.md
@@ -3,13 +3,13 @@
 
 Other pages in this language section describe various concepts and resources that appear in the Fides language. This page describes the syntax of the language in more detail to help better interpret Fides whether you're authoring or reading.
 
-The Fides language is an intentionally simple language designed to be relatively easy for anyone to read and write. The primary objective is to translate complex privacy compliance concepts into a simple syntax, it's for this reason Fides is entirely written as YAML configurations.
+The Fides language is designed to be relatively easy for anyone to read and write. The primary objective is to translate complex privacy compliance concepts into an approachable syntax, it's for this reason Fides is entirely written as YAML configurations.
 
 ## YAML - Building Block of Fides
 
 ### Fides Taxonomy
 
-The Fides language is intentionally simple. To assure this, Fides declarations use predefined primitives (e.g. data categories) that are used when describing your datasets, systems, policies, etc. These predefined primitives exist as part of the Fides taxonomy which is maintained in your `fidesctl` server so they can be consistently used across your organization's development team. 
+The Fides language is intentionally simple. To assure this, Fides declarations use predefined primitives (e.g. data categories) that are used when describing your datasets, systems, policies, etc. These predefined primitives exist as part of the Fides taxonomy which is maintained in your Fides server so they can be consistently used across your organization's development team. 
 
 You can learn more about the taxonomy structure and how to extend it in the [taxonomy guide](./taxonomy/overview.md).
 
diff --git a/mkdocs/docs/taxonomy/data_categories.md b/mkdocs/docs/taxonomy/data_categories.md
@@ -68,10 +68,10 @@ Below is a reference for all subcategories of `system` and `user` to assist with
 | `browsing_history`                | `user`                                    |Content browsing history of a user.                                                            |
 | `contact`                         | `user`                                    |User contact data.                                                                             |
 | `address`                         | `user.contact`                            |User contact data related to an address.                                                       |
+| `email`                           | `user.contact`                            |User's email address.                                                                          |
+| `phone_number`                    | `user.contact`                            |User's phone number.                                                                           |
 | `city`                            | `user.contact.address`                    |User's city level address data.                                                                |
 | `country`                         | `user.contact.address`                    |User's country level address data.                                                             |
-| `email`                           | `user.contact.address`                    |User's email address.                                                                          |
-| `phone_number`                    | `user.contact.address`                    |User's phone number.                                                                           |
 | `postal_code`                     | `user.contact.address`                    |User's postal code.                                                                            |
 | `state`                           | `user.contact.address`                    |User's state level address data.                                                               |
 | `street`                          | `user.contact.address`                    |User's street level address data.                                                              |
diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml
@@ -1,24 +1,27 @@
 site_name: Fides Language
 site_url: https://ethyca.github.io/fideslang
+
 nav:
-  - What is Fideslang?: index.md
-  - Overview: overview.md
-  - Fideslang Visual Explorer: explorer.md
-  - Syntax: syntax.md
-  - Taxonomy:
-      - Overview: taxonomy/overview.md
-      - Data Categories: taxonomy/data_categories.md
-      - Data Uses: taxonomy/data_uses.md
-      - Data Subjects: taxonomy/data_subjects.md
-      - Data Qualifiers: taxonomy/data_qualifiers.md
-  - Resources:
-      - Organization: resources/organization.md
-      - Policy: resources/policy.md
-      - Registry: resources/registry.md
-      - System: resources/system.md
-      - Dataset: resources/dataset.md
-  - Github Repo: https://github.com/ethyca/fideslang
-  - License: license.md
+  - Fides: https://ethyca.github.io/fides/
+  - Fides UI: https://ethyca.github.io/fides/ui/overview/
+  - Fides Lang: 
+      - What is Fideslang?: index.md
+      - Overview: overview.md
+      - Fideslang Visual Explorer: explorer.md
+      - Syntax: syntax.md
+      - Taxonomy:
+          - Overview: taxonomy/overview.md
+          - Data Categories: taxonomy/data_categories.md
+          - Data Uses: taxonomy/data_uses.md
+          - Data Subjects: taxonomy/data_subjects.md
+          - Data Qualifiers: taxonomy/data_qualifiers.md
+      - Resources:
+          - Organization: resources/organization.md
+          - Policy: resources/policy.md
+          - Registry: resources/registry.md
+          - System: resources/system.md
+          - Dataset: resources/dataset.md
+  - About Ethyca: https://ethyca.github.io/fides/ethyca/
 
 theme:
   palette:
@@ -40,6 +43,7 @@ theme:
   features:
     - navigation.top
     - navigation.instant
+    - navigation.tabs
   custom_dir: overrides
 
 markdown_extensions:
diff --git a/mkdocs/overrides/partials/footer.html b/mkdocs/overrides/partials/footer.html
@@ -111,16 +111,9 @@
         <div class="links-wrap">
             <div class="footer-col"> 
               <ul> 
-                <li> <a href= "/fides/"> Fidesctl </a> </li>
-                <li> <a href="/fides/quickstart/overview/"> Quick Start </a> </li>
-                <li> <a href="/fides/installation/installation/"> Installation </a></li>
-              </ul>
-            </div>
-            <div class="footer-col"> 
-              <ul> 
-                <li> <a href= "/fidesops/">  Fidesops </a> </li>
-                <li> <a href="/fidesops/use_cases/"> Use Cases </a> </li>
-                <li> <a href="/fidesops/getting_started/"> Getting Started </a></li>
+                <li> <a href= "/fides/"> Fides </a> </li>
+                <li> <a href="/fides/dsr_quickstart/basic_setup/"> DSR Automation </a> </li>
+                <li> <a href="/fides/ui/overview/"> Fides UI </a></li>
               </ul>
             </div>
             <div class="footer-col"> 
