documentation reorganization and page standardization (#858)

* copy changes to fix docs outlining [#427] and standardize formatting [DOX-216]

CHANGELOG.md

@@ -28,30 +28,29 @@ The types of changes are:
 * Store provided identity data in the privacy request table [#743](https://github.com/ethyca/fidesops/pull/834)
 * Adds exact match identity search to the privacy request status endpoint [#765](https://github.com/ethyca/fidesops/pull/847/)
 
+### Changed
+* Changed wording on Admin UI login page [#774](https://github.com/ethyca/fidesops/pull/774)
+* Fixed typos in Admin UI [#774](https://github.com/ethyca/fidesops/pull/774)
+* Update clipboard icon in Admin UI [#838](https://github.com/ethyca/fidesops/pull/838)
+* Stop masking uvicorn logs by default [#831](https://github.com/ethyca/fidesops/pull/831)
+* Bump fideslib to handle base64 encoded password [#820](https://github.com/ethyca/fidesops/pull/820)
+
 ### Developer Experience
 * Replace user authentication routes with fideslib routes [#811](https://github.com/ethyca/fidesops/pull/811)
 * Reduce docker image size [846](https://github.com/ethyca/fidesops/pull/846)
 
+### Docs
+* Backend UI deployment [#827](https://github.com/ethyca/fidesops/pull/827)
+* Fix publish_docs CI action [#818](https://github.com/ethyca/fidesops/pull/818)
+* Reorganize docs and standardize formatting [#858](https://github.com/ethyca/fidesops/pull/858)
+
 ### Fixed
 * Resolve issue with MyPy seeing files in fidesops as missing imports [#719](https://github.com/ethyca/fidesops/pull/719)
 * Fixed `check-migrations` Make command [#806](https://github.com/ethyca/fidesops/pull/806)
 * Fix issue requiring separate install of snowflake-connector-python [#807](https://github.com/ethyca/fidesops/pull/807)
 * [User Management] Create new user gives HTTP 422 Unprocessable Entity exception [#832] (https://github.com/ethyca/fidesops/pull/833)
-* [User Management] Refactored New and Edit user pages to reduce duplicate code [#839]https://github.com/ethyca/fidesops/pull/839
-
-### Docs
-* Backend UI deployment [#827](https://github.com/ethyca/fidesops/pull/827)
-* Fix publish_docs CI action [#818](https://github.com/ethyca/fidesops/pull/818)
-* Bump fideslib to handle base64 encoded password [#820](https://github.com/ethyca/fidesops/pull/820)
-* Stop masking uvicorn logs by default [#831](https://github.com/ethyca/fidesops/pull/831)
 * Fix error when there are no scopes in `ClientDetail` [#830](https://github.com/ethyca/fidesops/pull/830)
-
-## Changed
-* Changed wording on Admin UI login page [#774](https://github.com/ethyca/fidesops/pull/774)
-* Fixed typos in Admin UI [#774](https://github.com/ethyca/fidesops/pull/774)
-* Update clipboard icon in Admin UI [#838](https://github.com/ethyca/fidesops/pull/838)
-* Update admin ui to be served from the root route `/` [#720](https://github.com/ethyca/fidesops/pull/720)
-
+* [User Management] Refactored New and Edit user pages to reduce duplicate code [#839]https://github.com/ethyca/fidesops/pull/839
 
 ## [1.6.1](https://github.com/ethyca/fidesops/compare/1.6.0...1.6.1)
 

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/fidesops/community/code_of_conduct/).
+The Fides project, which includes fideslang, fidesops, and fidesctl, adheres to the following [Code of Conduct](https://ethyca.github.io/fidesops/community/code_of_conduct/).
 
 The Fides core team welcomes any contributions and suggestions to help make the community a better place 🤝

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/fidesops/development/overview/).
+The Fides project, which includes fideslang, fidesops, and fidesctl, adheres to the following [Contribution Guidelines](https://ethyca.github.io/fidesops/development/overview/).
 
 The Fides core team welcomes any contributions and suggestions to help make the community a better place 🤝

README.md

@@ -14,9 +14,9 @@ _A part of the [greater Fides ecosystem](https://github.com/ethyca/fides)._
 
 ![Fidesops overview](docs/fidesops/docs/img/fidesops-overview-diagram.png "Fidesops overview")
 ## :rocket: Quick Start
-If you're looking for a more detailed introduction to Fidesops, we recommend following [our tutorial here](https://ethyca.github.io/fidesops/tutorial/). 
+If you're looking for a more detailed introduction to fidesops, we recommend following [our tutorial here](https://ethyca.github.io/fidesops/tutorial/). 
 
-Run the quickstart in your terminal to give Fidesops a test drive:
+Run the quickstart in your terminal to give fidesops a test drive:
 
 ```
 Install Docker: https://docs.docker.com/desktop/#download-and-install
@@ -165,13 +165,13 @@ related to "jane@example.com". Then we'll re-run step #3 again to see what data
 This returns an empty dictionary confirming Jane's fields with data category `user.provided.identifiable` have been removed.
 
 
-You've learned how to use the Fidesops API to connect a database and a final storage location, define policies that describe
+You've learned how to use the fidesops API to connect a database and a final storage location, define policies that describe
 how to handle user data, and execute access and erasure requests.  But there's a lot more to discover,
 so we'd recommend following [the tutorial](https://ethyca.github.io/fidesops/tutorial/) to keep learning.
 
 ### Documentation
 
-For more information on getting started with Fidesops, how to configure and set up Fidesops, and more about the Fides ecosystem of open source projects: 
+For more information on getting started with fidesops, how to configure and set up fidesops, and more about the Fides ecosystem of open source projects: 
 
 - Documentation: https://ethyca.github.io/fidesops/
 - How-to guides: https://ethyca.github.io/fidesops/guides/oauth/
@@ -196,8 +196,8 @@ Read about the [Fides community](https://ethyca.github.io/fidesops/community/git
 
 ## :balance_scale: License
 
-The Fides ecosystem of tools ([Fidesops](https://github.com/ethyca/fidesops) and [Fidesctl](https://github.com/ethyca/fides)) are licensed under the [Apache Software License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
-Fides tools are built on [Fideslang](https://github.com/ethyca/privacy-taxonomy), the Fides language specification, which is licensed under [CC by 4](https://github.com/ethyca/privacy-taxonomy/blob/main/LICENSE). 
+The Fides ecosystem of tools ([fidesops](https://github.com/ethyca/fidesops) and [fidesctl](https://github.com/ethyca/fides)) are licensed under the [Apache Software License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+Fides tools are built on [fideslang](https://github.com/ethyca/privacy-taxonomy), the Fides language specification, which is licensed under [CC by 4](https://github.com/ethyca/privacy-taxonomy/blob/main/LICENSE). 
 
 Fides is created and sponsored by [Ethyca](https://ethyca.com): a developer tools company building the trust infrastructure of the internet. If you have questions or need assistance getting started, let us know at fides@ethyca.com!
 

docs/fidesops/docs/api/index.md

@@ -1,7 +1,7 @@
 # API Reference
 
-You can view the live, interactive [Swagger](https://swagger.io/docs/) API docs for Fidesops 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 our [Fidesops Postman Collection](../postman/Fidesops.postman_collection.json) and [follow instructions
+You can view the live, interactive [Swagger](https://swagger.io/docs/) API docs for fidesops 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 our [fidesops Postman collection](../postman/Fidesops.postman_collection.json) and [follow instructions
 to set up on your machine](../postman/using_postman.md).
 
 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!

docs/fidesops/docs/development/code_style.md

@@ -6,7 +6,7 @@
 
 Fides'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.
 
-To apply black to your code, run black from the root Fidesops directory:
+To apply black to your code, run black from the root fidesops directory:
 
 ```bash
 cd fidesops
@@ -19,7 +19,7 @@ A number of extensions are available for popular editors that will automatically
 
 Fides'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.
 
-To apply pylint to your code, run pylint from the root Fidesops directory:
+To apply pylint to your code, run pylint from the root fidesops directory:
 
 ```bash
 cd fidesops

docs/fidesops/docs/development/contributing_details.md

@@ -5,7 +5,7 @@
 ## API Endpoints
 
 ### Postman API Collection
-Our [Fidesops Postman Collection](../postman/Fidesops.postman_collection.json) can be used to test Fidesops endpoints.
+Our [fidesops Postman Collection](../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.
 

docs/fidesops/docs/development/documentation.md

@@ -1,7 +1,5 @@
 # Documentation
 
----
-
 Documentation is incredibly important to Fides, both for explaining its concepts to general audiences and describing its usage to developers.
 
 ## Concepts
@@ -14,7 +12,7 @@ To write concept docs, add Markdown files to the `docs/fidesops/docs/` directory
 
 ### Capitalization
 
-Concepts that refer to proper nouns or are trademarked should always be capitalized, including "Fides" and "Fidesops".
+Concepts that refer to proper nouns or are trademarked should always be capitalized, including "Fides". Fides tools, such as "fidesops" and "fidesctl" should always be lowercase.
 
 Other Fides terms, like "Data Category" or "System", should also be capitalized to be clear about the fact that a Fides resource is being referenced.
 

docs/fidesops/docs/development/jetbrains_debugging.md

@@ -1,5 +1,5 @@
-# Debugging Fidesops in IntelliJ IDEA Ultimate
-This guide will show how to use the IntelliJ debugger with Fidesops running in Docker. 
+# Debugging fidesops in IntelliJ IDEA Ultimate
+This guide will show how to use the IntelliJ debugger with fidesops running in Docker. 
 The setup for PyCharm Professional should be very similar.
 
 ## Prerequisites
@@ -42,11 +42,11 @@ See screenshots below:
 
 ### Run/Debug Configuration
 
-Set up a Run/Debug Configuration so that breakpoints can be hit in the Fidesops sourcecode. 
+Set up a Run/Debug Configuration so that breakpoints can be hit in the f sourcecode. 
 
 Go to: **Run/Debug Configurations** -> **+** -> **Python**
 
-- To debug Fidesops, debug the `<path on your machine>/src/fidesops/main.py` script
+- To debug fidesops, debug the `<path on your machine>/src/fidesops/main.py` script
 - Make sure to select **Use specified interpreter** set the Remote Python Docker Compose *(created in the previous section)*
 - Add `FIDESOPS__CONFIG_PATH=/fidesops` to **Environment variables**
 
@@ -58,7 +58,7 @@ See screenshot below:
 
 Now the IDE is ready to debug the source code. Click the debug button for **main** *(setup in the previous section)*.
 
-Try firing a http request to Fidesops from Postman or Curl and hit a break point. 
+Try firing a http request to fidesops from Postman or Curl and hit a break point. 
 
 There is a postman collection in this repo: `docs/fidesops/docs/postman/Fidesops.postman_collection.json`
 

docs/fidesops/docs/development/overview.md

@@ -2,13 +2,13 @@
 
 ---
 
-Thanks for contributing to Fidesops! 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 fidesops! 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/fidesops/issues).
 
-## Getting Started with Fidesops in Docker
+## Getting started with fidesops in Docker
 
-The recommended way to run Fidesops is to launch it with Docker and Docker Compose. `Make` commands wrap docker-compose 
+The recommended way to run fidesops is to launch it with Docker and Docker Compose. `Make` commands wrap docker-compose 
 commands to give you different functionality.
 
 ### System Requirements 
@@ -23,7 +23,7 @@ commands to give you different functionality.
 ### Available make commands
 - `make server` - this spins up the Fastapi server and supporting resources (a Postgres database and a Redis cache), which you can visit at `http://0.0.0.0:8080`. Check out the docs at `http://0.0.0.0:8000/fidesops/`
 - `make integration-env` - spins up everything in make server, plus additional postgres, mongo, and mysql databases for you to execute privacy requests against.
-    - Try this out locally with our [Fidesops Postman Collection](../postman/Fidesops.postman_collection.json)
+    - Try this out locally with our [fidesops Postman collection](../postman/Fidesops.postman_collection.json)
     - `make integration-env datastores="mysql mariadb"`- brings up only mysql and mariadb datastores 
 - `make integration-shell` - spins up everything in make server, plus all Docker Compose specified datastores (Postgres, MySQL, MSSQL, Mongodb) and opens a server shell. This is most useful for running `pytest -k ...` commands within the integration shell to test connected datastores.
 - `make black`, `make mypy`, and `make pylint` - auto-formats code
@@ -36,8 +36,8 @@ commands to give you different functionality.
 - `make pytest-integration datastores="postgres snowflake mssql"` - runs access integration tests for the Postgres, Snowflake and MSSQL environments. NB. This can be used to run integration tests on external datastores if those datastores are explicitly specified.
 - `make pytest-integration-external` - runs only external integration tests.
 - `make pytest-integration-erasure` - runs erasure integration tests.
-- `make reset-db` - tears down the Fidesops postgres db, then recreates and re-runs migrations.
-- `make quickstart` - runs a quick, five minute quickstart that talks to the Fidesops API to execute privacy requests
+- `make reset-db` - tears down the fidesops postgres db, then recreates and re-runs migrations.
+- `make quickstart` - runs a quick, five minute quickstart that talks to the fidesops API to execute privacy requests
 - `make check-migrations` - verifies there are no un-run migrations 
 - `make docs-serve` - spins up just the docs, which you can visit at `http://0.0.0.0:8000/fidesops/`
 
@@ -49,14 +49,14 @@ See [Makefile](https://github.com/ethyca/fidesops/blob/main/Makefile) for more o
 - 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 `make server`, if you get a `importlib.metadata.PackageNotFoundError: fidesops`, do `make server-shell`,
-and then run `pip install -e .`. Verify Fidesops is installed with `pip list`.
+and then run `pip install -e .`. Verify fidesops is installed with `pip list`.
 
 
 ## Write your code
 
 See the [contributing details](contributing_details.md) guide to get familiar with writing and testing API endpoints, database models, and more. 
 
-We want to help you ensure your code plays nicely with the rest of the Fidesops ecosystem. Many projects describe code style and documentation as a suggestion; in Fidesops it's a CI-checked requirement.
+We want to help you ensure your code plays nicely with the rest of the fidesops ecosystem. Many projects describe code style and documentation as a suggestion; in fidesops it's a CI-checked requirement.
 
 * To learn how to style your code, see the [style guide](code_style.md).
 * To learn how to document your code, see the [docs guide](documentation.md).
@@ -66,9 +66,9 @@ We want to help you ensure your code plays nicely with the rest of the Fidesops
 
 ## Submit your code
 
-In order to submit code to Fidesops, please:
+In order to submit code to fidesops, please:
 
-* [Fork the Fidesops repository](https://help.github.com/en/articles/fork-a-repo)
+* [Fork the fidesops repository](https://help.github.com/en/articles/fork-a-repo)
 * Add the original as a remote (I'm naming it `upstream`), to keep your fork in sync
   ```bash
   git remote add upstream https://github.com/ethyca/fidesops.git
@@ -84,9 +84,9 @@ In order to submit code to Fidesops, please:
     ```
 * [Open a Pull Request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork) once your work is ready for review
   * Submit the pull request from *your* repo. Pull requests should be submitted with a clear description of the issue being handled, including links to any external specifications or Github issues. PRs should not be merged by the person submitting them, except in rare and urgent circumstances.
-  * 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 Fidesops.
+  * 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 fidesops.
 
 
 ## Congratulations
 
-You're a Fidesops contributor - welcome to the team! 🎉
+You're a fidesops contributor - welcome to the team! 🎉

docs/fidesops/docs/development/testing.md

@@ -51,7 +51,7 @@ Fidesops has a few [`pytest` fixtures](https://docs.pytest.org/en/stable/fixture
 
 Fidesops uses `pytest` for unit testing. As with other `make` commands, you have the option to run `pytest` in command-line or in application shell:
 
-1. In shell: Once in the Fidesops container shell (`make server-shell`, or `make integration-shell` if running integration tests), invoke `pytest` from the root Fidesops directory:
+1. In shell: Once in the fidesops container shell (`make server-shell`, or `make integration-shell` if running integration tests), invoke `pytest` from the root fidesops directory:
 
 ```bash
 cd fidesops

docs/fidesops/docs/development/update_erd_diagram.md

@@ -1,6 +1,6 @@
 # Updating database diagram
 
-If you make updates to the Fidesops application database, you should update our DB Architecture diagram in the 
+If you make updates to the fidesops application database, you should update our DB Architecture diagram in the 
 documentation.
 
 1. Connect [DBeaver](https://dbeaver.io/) to our `app` DB container

docs/fidesops/docs/ethyca.md

@@ -4,7 +4,7 @@ The mission of Ethyca is to make Internet-scale technology respectful and ethica
 
 ## What is Fides?
 
-Fides is a universally understandable, open-source language that can be used to describe privacy within tech infrastructure. Our existing tools ([Fidesctl](https://github.com/ethyca/fides/) and [Fidesops](https://github.com/ethyca/fidesops/)) use this language to power a low friction set of developer tools that integrate with your existing CI pipelines, making privacy a feature of your tech stack. With Fides, we hope everyone can build better tools for privacy in the next decade and beyond. 
+Fides is a universally understandable, open-source language that can be used to describe privacy within tech infrastructure. Our existing tools ([fidesctl](https://github.com/ethyca/fides/) and [fidesops](https://github.com/ethyca/fidesops/)) use this language to power a low friction set of developer tools that integrate with your existing CI pipelines, making privacy a feature of your tech stack. With Fides, we hope everyone can build better tools for privacy in the next decade and beyond. 
 
 ## What we Believe