diff --git a/CHANGELOG.md b/CHANGELOG.md index aee0743fd4..88463c21be 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,10 @@ The types of changes are: ## [Unreleased](https://github.com/ethyca/fides/compare/2.4.0...main) +### Docs + +* Update the docs landing page and remove redundant docs [#2184](https://github.com/ethyca/fides/pull/2184) + ### Added * Added the connection key to the execution log [#2100](https://github.com/ethyca/fides/pull/2100) @@ -148,7 +152,6 @@ The types of changes are: * Remove duplicate fastapi-caching and pin version. [#1765](https://github.com/ethyca/fides/pull/1765) - ## [2.2.0](https://github.com/ethyca/fides/compare/2.1.0...2.2.0) ### Added @@ -231,7 +234,6 @@ The types of changes are: * Bumped versions of packages that use OpenSSL [#1683](https://github.com/ethyca/fides/pull/1683) - ## [2.0.0](https://github.com/ethyca/fides/compare/1.9.6...2.0.0) ### Added diff --git a/docs/README.md b/docs/README.md index 54b3cd9560..148ede534e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,5 @@ # Fides Docs -This is where the docs site for Fides lives. To run the docs locally, use `nox -s docs_serve` and visit `localhost:8000` +This is where the autogenerated docs for Fides lives. To run the docs locally, use `nox -s docs_serve` and visit `localhost:8000` + +The full, official docs live at https://docs.ethyca.com/fides/overview diff --git a/docs/fides/docs/api/index.md b/docs/fides/docs/api/index.md index 5d75f69aff..bdd73de89b 100644 --- a/docs/fides/docs/api/index.md +++ b/docs/fides/docs/api/index.md @@ -1,18 +1,17 @@ # API Reference 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 [Postman collection](../development/postman/Fides.postman_collection.json) and [follow instructions](../development/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. +All API routes will automatically matched with and without a trailing slash `/`. So `/api/v1/config` and `/api/v1/config/` are both valid API calls. --- !!swagger openapi.json!!