Merge Ops/Ctl docs (#1049)

* Merge Ops/Ctl docs * fix serving the docs * reorg fidesops docs into subdir for mkdocs build * reorganize fidesops docs, mkdocs config * fix the docs build * fides copy, update uses of fidesctl/ops to fides, fix links with removed taxonomy Co-authored-by: Cole <cole@ethyca.com>
ethyca · ThomasLaPiana · Jun 22, 2022 · Jun 22, 2022 · Jun 22, 2022 · Jun 23, 2022
commit 1a4bb0a74d6a08d75c721cb3f1379c6e06e30b18
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 fides & fideslang adheres to the following [Code of Conduct](https://ethyca.github.io/fides/community/code_of_conduct/).
+The Fides project, which includes fidesctl, fidesops, and 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 fides & fideslang, adheres to the following [Contribution Guidelines](https://ethyca.github.io/fides/development/overview/).
+The Fides project, which includes fidesctl, fidesops, and 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/docker-compose.yml b/docker-compose.yml
@@ -77,6 +77,10 @@ services:
     volumes:
       - ./docs/fides:/docs
       - ./:/fides
+    expose:
+      - 8000
+    ports:
+      - "8000:8000"
     environment:
       - FIDES__DEV_MODE=True
       - FIDES__CLI__ANALYTICS_ID=${FIDES__CLI__ANALYTICS_ID}

diff --git a/docs/fides/docs/admin_ui/local_dev.md b/docs/fides/docs/admin_ui/local_dev.md
diff --git a/docs/fides/docs/api/index.md b/docs/fides/docs/api/index.md
@@ -1,6 +1,11 @@
-# Fidesctl API
+# API Reference
 
-These docs represent the cutting-edge, and may contain endpoints/features that have yet to be released in stable versions.
+You can view the live, interactive [Swagger](https://swagger.io/docs/) API docs for Fides by visiting `/docs` on a running instance. This is a great way to experiment with the APIs using Swagger's built-in "Try it out" functionality.
+Additionally, you can download the [fidesops Postman collection](../fidesops/postman/Fidesops.postman_collection.json) and [follow instructions](../fidesops/postman/using_postman.md) to set up on your machine.
+
+Below, we've embedded the latest release's API documentation as a living reference. These work largely the same, but since this documentation site isn't connected to a live instance, the "Try it out" and "Authorize" buttons won't work, sorry!
+
+All API routes will automatically match with and without a trailing slash `/`. So `/api/v1/config` and `/api/v1/config/` are both valid API calls.
 
 ---
 

diff --git a/docs/fides/docs/css/fides.css b/docs/fides/docs/css/fides.css
@@ -62,6 +62,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;
@@ -453,4 +457,4 @@ form.hs-form{
     .hs-form .hs_submit{
         margin-left: 10px;
     }
-}
+}
diff --git a/docs/fides/docs/development/code_style.md b/docs/fides/docs/development/code_style.md
@@ -1,7 +1,4 @@
 # Code Style
-
----
-
 ## General
 
 ### Docstrings
@@ -76,7 +73,7 @@ foods_list: List[str] = ["apple", "banana"]
 
 ## Pre-Commit Hooks
 
-Fidesctl includes a `.pre-commit-config.yaml` to facilitate running CI checks before pushing up to a PR. The `pre-commit` package is included in the `dev-requirements.txt`. Once that is installed, follow these steps to get up and running:
+Fides includes a `.pre-commit-config.yaml` to facilitate running CI checks before pushing up to a PR. The `pre-commit` package is included in the `dev-requirements.txt`. Once that is installed, follow these steps to get up and running:
 
 1. `pre-commit install` - This is a one-time setup step to create the git pre-commit hooks.
 1. These pre-commit hooks will now run automatically. However you can also use `pre-commit run` to run them manually once all of your changes have been staged.
@@ -99,18 +96,18 @@ nox -s xenon
 
 ### Black formatting
 
-Fidesctl's code is formatted using the [black](https://github.com/ambv/black) style. This style is checked in a CI step, and merges to master are prevented if code does not conform.
+Fides' code is formatted using the [black](https://github.com/ambv/black) style. This style is checked in a CI step, and merges to master are prevented if code does not conform.
 
 A number of extensions are available for popular editors that will automatically apply black to your code.
 
 ### Pylint
 
-Fidesctl's code is linted using [pylint](https://pylint.org/). Linter checks run as part of a CI step and merges to master are prevented if code does not conform.
+Fides' code is linted using [pylint](https://pylint.org/). Linter checks run as part of a CI step and merges to master are prevented if code does not conform.
 
 ### Mypy
 
-Fidesctl's code is statically-typed using [mypy](http://mypy-lang.org/). Type checking is validated as a CI step, and merges to master are prevented if code does not pass type checks. As a general rule, mypy typing requires all function arguments and return values to be annotated.
+Fides' code is statically-typed using [mypy](http://mypy-lang.org/). Type checking is validated as a CI step, and merges to master are prevented if code does not pass type checks. As a general rule, mypy typing requires all function arguments and return values to be annotated.
 
 ### Xenon
 
-Fidesctl's code is checked for its cyclomatic-complexity by Xenon. If a single logical piece of code is deemed too complex, then a CI step will fail, at which point the focus should be on breaking up said complex function/method/class.
+Fides' code is checked for its cyclomatic-complexity by Xenon. If a single logical piece of code is deemed too complex, then a CI step will fail, at which point the focus should be on breaking up said complex function/method/class.
diff --git a/.../docs/development/contributing_details.md → .../docs/development/contributing_details.md b/.../docs/development/contributing_details.md → .../docs/development/contributing_details.md
@@ -6,9 +6,9 @@
 
 ### Postman API Collection
 
-Our [fidesops Postman Collection](../postman/Fidesops.postman_collection.json) can be used to test fidesops endpoints.
+Our [fidesops Postman Collection](../fidesops/postman/Fidesops.postman_collection.json) can be used to test fidesops endpoints.
 
-Follow our [Using Postman](../postman/using_postman.md) guide to learn more about the how to use the collection.
+Follow our [Using Postman](../fidesops/postman/using_postman.md) guide to learn more about the how to use the collection.
 
 ### API URLs
 

diff --git a/docs/fides/docs/development/database_migration.md b/docs/fides/docs/development/database_migration.md
@@ -1,14 +1,12 @@
 # Database Migration
 
----
-
-Changes to fidesctl could require a change to the database model. This includes scenarios where you want to persist a new field or replace an existing field. Changes made to the fidesctl database are done through alembic migration scripts. Migrations can be found in the following direcotry: `src/fidesctl/api/ctl/migrations/versions`
+Changes to Fides could require a change to the database model. This includes scenarios where you want to persist a new field or replace an existing field. Changes made to the Fides databases are done through alembic migration scripts. Migrations can be found in the following directory: `src/fides/api/ctl/migrations/versions`
 
 To create a new migration we use the `alembic revision` command:
 
 ```bash
-cd src/fidesctl/api/ctl
+cd src/fides/api/ctl
 alembic revision --autogenerate -m "migration message"
 ```
 
-The autogenerated script should be verified and could require some manual changes. Migrations will run on the fidesctl server startup.
+The autogenerated script should be verified and could require some manual changes. Migrations will run on server startup.
diff --git a/docs/fidesops/docs/development/fideslog.md → docs/fides/docs/development/fideslog.md b/docs/fidesops/docs/development/fideslog.md → docs/fides/docs/development/fideslog.md
@@ -1,17 +1,17 @@
 # Fideslog Analytics
 
-Fidesops includes an implementation of [fideslog](https://github.com/ethyca/fideslog) to provide Ethyca with an understanding of user interactions with fides tooling. 
+Fides includes an implementation of [fideslog](https://github.com/ethyca/fideslog) to provide Ethyca with an understanding of user interactions with fides tooling. 
 
 All collected analytics are anonymized, and only used in either product roadmap determination, or as insight into product adoption. Information collected by fideslog is received via HTTPs request, stored in a secure database, and never shared with third parties unless required by law.
 
 More information on use, implementation, and configuration can be found in the [fideslog repository](https://github.com/ethyca/fideslog#readme).
 
 ## Collected Data
-Fideslog collects information on instances of fidesops by recording internal events. Using fidesops may result in sending any or all of the following analytics data to Ethyca:  
+Fideslog collects information on instances of Fides by recording internal events. Using Fides may result in sending any or all of the following analytics data to Ethyca:  
 
 | Parameter | Description |
 |----|----|
-| `docker` | If fidesops is run in a docker container. |
+| `docker` | If fides is run in a docker container. |
 | `event` | The type of analytics event - currently, either a **server start** or **endpoint call**.
 | `event_created` | The time of the event. |
 | `endpoint` | The endpoint accessed. |
@@ -20,11 +20,9 @@ Fideslog collects information on instances of fidesops by recording internal eve
 
 ## Disabling Fideslog
 
-To opt out of analytics, set either the following fidesops environment variable or `.toml` configuration variable to `True`. 
+To opt out of analytics, set either the following fides environment variable or `.toml` configuration variable to `True`. 
 
 | Variable | Default | Use | 
 |---|---|---|
-| `analytics_opt_out` | False | Include in your `fidesops.toml` file. | 
-| `FIDESOPS__USER__ANALYTICS_OPT_OUT` | False | Include in your environment variables. |
-
-For more information, see the fidesops [configuration guide](../guides/configuration_reference.md).
+| `analytics_opt_out` | False | Include in your `fides.toml` file. | 
+| `FIDESOPS__USER__ANALYTICS_OPT_OUT` | False | Include in your environment variables. |
diff --git a/...s/docs/development/jetbrains_debugging.md → ...s/docs/development/jetbrains_debugging.md b/...s/docs/development/jetbrains_debugging.md → ...s/docs/development/jetbrains_debugging.md
@@ -20,7 +20,7 @@ Go to: **Settings/Preferences** -> **Docker** -> **+**
 
 See the screenshot below:
 
-![Screenshot of IDE Docker setup](../img/ide/docker.png)
+![Screenshot of IDE Docker setup](../fidesops/img/ide/docker.png)
 
 ### Configure Python Remote Interpreter
 
@@ -36,9 +36,9 @@ After clicking **OK** the Remote Python Docker Compose should be listed as an SD
 
 See screenshots below:
 
-![Screenshot of Add Python Interpreter](../img/ide/add_python_interpreter.png)
+![Screenshot of Add Python Interpreter](../fidesops/img/ide/add_python_interpreter.png)
 
-![Screenshot of Project Structure SDKs](../img/ide/SDKs.png)
+![Screenshot of Project Structure SDKs](../fidesops/img/ide/SDKs.png)
 
 ### Run/Debug Configuration
 
@@ -52,7 +52,7 @@ Go to: **Run/Debug Configurations** -> **+** -> **Python**
 
 See screenshot below:
 
-![Screenshot of Run/Debug Configuration for main.py](../img/ide/debug_config.png)
+![Screenshot of Run/Debug Configuration for main.py](../fidesops/img/ide/debug_config.png)
 
 ## Hit a Breakpoint
 
@@ -64,7 +64,7 @@ There is a postman collection in this repo: `docs/fidesops/docs/postman/Fidesops
 
 Screenshot of hit breakpoint below:
 
-![Screenshot of Debugging from IntelliJ](../img/ide/debugging.png)
+![Screenshot of Debugging from IntelliJ](../fidesops/img/ide/debugging.png)
 
 ## Links
 

diff --git a/docs/fides/docs/development/overview.md b/docs/fides/docs/development/overview.md
@@ -1,14 +1,12 @@
 # Development Overview
 
----
-
-Thanks for contributing to Fidesctl! This section of the docs is designed to help you become familiar with how we work, the standards we apply, and how to ensure your contribution is successful.
+Thanks for contributing to Fides! This section of the docs is designed to help you become familiar with how we work, the standards we apply, and how to ensure your contribution is successful.
 
 If you're stuck, don't be shy about asking for help [on GitHub](https://github.com/ethyca/fides/issues).
 
 ## Getting Started
 
-The first step is to clone the Fidesctl repo for development:
+The first step is to clone the Fides repo for development:
 
 ```bash
 git clone https://github.com/ethyca/fides
@@ -18,23 +16,28 @@ Once that's complete, there are a few different ways to spin up the project and
 
 ### Developer Workflows
 
-There are a few different ways to develop Fidesctl, they are listed below _in order of how strongly they are recommended!_
+There are a few different ways to develop Fides, they are listed below _in order of how strongly they are recommended!_
 
-1. If you're using VS Code, the recommended way to work on Fidesctl is by leveraging the Dev Containers feature. The repo has a `.devcontainer/devcontainer.json` file already included that will set up a complete environment in VS Code, including the suggested VS Code extensions and settings. Follow these steps to get started:
+1. If you're using VS Code, the recommended way to work on Fides is by leveraging the Dev Containers feature. The repo has a `.devcontainer/devcontainer.json` file already included that will set up a complete environment in VS Code, including the suggested VS Code extensions and settings. Follow these steps to get started:
     1. Install the `Remote-Containers` extension for VS Code.
     1. Open the command window (the F1 key will open it, by default) and select the `Remote-Containers: Open Folder in Container...` command.
     1. Click "Open", without having selected any specific folder.
-    1. The containers will now spin up and VS Code will be running inside of the containers. The bottom left of the IDE will now say `Dev Container: Fidesctl`.
-    1. When you open a new VS Code shell, it will be inside of the `fidesctl` container, and you'll have access to all of the `fidesctl` commands as well as any Python commands like `pytest`, `black`, `mypy`, etc.
-1. If you're using an editor besides VS Code, then the next best way to work on Fidesctl is by utilizing the `Noxfile` commands:
+    1. The containers will now spin up and VS Code will be running inside of the containers. The bottom left of the IDE will now say `Dev Container: Fides`.
+    1. When you open a new VS Code shell, it will be inside of the `fides` container, and you'll have access to all of the `fides` commands as well as any Python commands like `pytest`, `black`, `mypy`, etc.
+1. If you're using an editor besides VS Code, then the next best way to work on Fides is by utilizing the `Noxfile` commands:
     1. Make sure that you have `docker`, `docker-compose` and `nox` (`pipx install nox`) installed.
-    1. Once you have everything set up, run `nox -s cli` to spin up a shell within the `fidesctl` container.
+    1. Once you have everything set up, run `nox -s cli` to spin up a shell within the `fides` container.
     1. You can and should run all of your various development commands from within this shell, such as `pytest`, `black`, etc.
 1. Finally, the least-recommended method would be to install the project in your local environment and develop directly.
 
+#### Issues 
+
+- MSSQL: Known issues around connecting to MSSQL exist today for Apple M1 users. M1 users that wish to install `pyodbc` locally, please reference the workaround [here](https://github.com/mkleehammer/pyodbc/issues/846).
+
+- Package not found: When running `nox -s dev`, if you get a `importlib.metadata.PackageNotFoundError: fidesops`, do `nox -s dev -- shell`, and then run `pip install -e .`. Verify fidesops is installed with `pip list`.
 ### Write your code
 
-We have no doubt you can write amazing code! However, we want to help you ensure your code plays nicely with the rest of the Fidesctl ecosystem. Many projects describe code style and documentation as a suggestion; in Fidesctl it's a CI-checked requirement.
+We have no doubt you can write amazing code! However, we want to help you ensure your code plays nicely with the rest of the Fides ecosystem. Many projects describe code style and documentation as a suggestion; in Fides it's a CI-checked requirement.
 
 * To learn how to style your code, see the [style guide](code_style.md).
 * To learn how to migrate the database schema, see the [database migration guide](database_migration.md).
@@ -44,13 +47,13 @@ We have no doubt you can write amazing code! However, we want to help you ensure
 
 ### Submit your code
 
-In order to submit code to Fidesctl, please:
+In order to submit code to Fides, please:
 
-* [Fork the Fidesctl repository](https://help.github.com/en/articles/fork-a-repo)
+* [Fork the Fides repository](https://help.github.com/en/articles/fork-a-repo)
 * [Create a new branch](https://help.github.com/en/desktop/contributing-to-projects/creating-a-branch-for-your-work) on your fork
 * [Open a Pull Request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork) once your work is ready for review
-* Once automated tests have passed, a maintainer will review your PR and provide feedback on any changes it requires to be approved. Once approved, your PR will be merged into Fidesctl.
+* Once automated tests have passed, a maintainer will review your PR and provide feedback on any changes it requires to be approved. Once approved, your PR will be merged into Fides.
 
 ### Congratulations
 
-You're a Fidesctl contributor - welcome to the team! 🎉
+You're a Fides contributor - welcome to the team! 🎉
diff --git a/...ops/docs/development/release_checklist.md → ...des/docs/development/release_checklist.md b/...ops/docs/development/release_checklist.md → ...des/docs/development/release_checklist.md
diff --git a/...ps/docs/development/update_erd_diagram.md → ...es/docs/development/update_erd_diagram.md b/...ps/docs/development/update_erd_diagram.md → ...es/docs/development/update_erd_diagram.md
@@ -6,7 +6,7 @@ documentation.
 1. Connect [DBeaver](https://dbeaver.io/) to our `app` DB container
    1. DBeaver > Database > New Database Connection > PostgreSQL
       1. Add configuration details
-      ![Connect app database](../img/connect_app_db_to_dbeaver.png)
+      ![Connect app database](../fidesops/img/connect_app_db_to_dbeaver.png)
       2. Right-click on postgres connection > Create > Other 
       3. Select ER Diagram, Click Next
       4. Drill down to Postgres > app > Schemas > public and click the checkbox.

diff --git a/docs/fides/docs/ethyca.md b/docs/fides/docs/ethyca.md
@@ -20,4 +20,4 @@ We'd love you to contribute to Fides and you can do this directly as part of the
 
 ## Your Participation
 
-Fides' success is predicated on your participation -- Privacy as Code can only become a reality if we ensure it's easy to understand, implement and an interopable standard for wide adoption. Your feedback, contributions and improvements are encouraged as we work towards building a community with the sole objective of building more repsectful software for everyone on the internet.
+Fides' success is predicated on your participation -- Privacy as Code can only become a reality if we ensure it's easy to understand, implement and an interoperable standard for wide adoption. Your feedback, contributions and improvements are encouraged as we work towards building a community with the sole objective of building more respectful software for everyone on the internet.
diff --git a/docs/fides/docs/admin_ui/datasets.md → .../fides/docs/fidesctl/admin_ui/datasets.md b/docs/fides/docs/admin_ui/datasets.md → .../fides/docs/fidesctl/admin_ui/datasets.md
@@ -1,6 +1,6 @@
 # Managing Datasets 
 
-The Admin UI's Datasets panel allows you to easily view, add, edit, and configure your existing [datasets](../language/resources/dataset.md) and their connections.
+The Admin UI's Datasets panel allows you to easily view, add, edit, and configure your existing [datasets](https://ethyca.github.io/fideslang/resources/dataset/) and their connections.
 
 ## Adding a dataset
Original file line number	Diff line number	Diff line change
Expand Up		@@ -20,4 +20,4 @@ We'd love you to contribute to Fides and you can do this directly as part of the

		## Your Participation

		Fides' success is predicated on your participation -- Privacy as Code can only become a reality if we ensure it's easy to understand, implement and an interopable standard for wide adoption. Your feedback, contributions and improvements are encouraged as we work towards building a community with the sole objective of building more repsectful software for everyone on the internet.
		Fides' success is predicated on your participation -- Privacy as Code can only become a reality if we ensure it's easy to understand, implement and an interoperable standard for wide adoption. Your feedback, contributions and improvements are encouraged as we work towards building a community with the sole objective of building more respectful software for everyone on the internet.