Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup Legacy docs #2184

Merged
merged 4 commits into from
Jan 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -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
5 changes: 2 additions & 3 deletions docs/fides/docs/api/index.md
Original file line number Diff line number Diff line change
@@ -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!!

<script>
/* If there is an anchor tag, reload it after the page loads to scroll to
/*If there is an anchor tag, reload it after the page loads to scroll to
* that section, since the Swagger UI takes some time to render. */
if (location.hash) {
setTimeout(function() {
Expand Down
215 changes: 0 additions & 215 deletions docs/fides/docs/cicd.md

This file was deleted.

79 changes: 0 additions & 79 deletions docs/fides/docs/csv/data_categories.csv

This file was deleted.

7 changes: 0 additions & 7 deletions docs/fides/docs/csv/data_qualifiers.csv

This file was deleted.

17 changes: 0 additions & 17 deletions docs/fides/docs/csv/data_subjects.csv

This file was deleted.

Loading