Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Documentation, README, Branding, and links update #7

Merged
merged 7 commits into from
Oct 31, 2021
Merged

Documentation, README, Branding, and links update #7

merged 7 commits into from
Oct 31, 2021

Conversation

iamkelllly
Copy link
Contributor

@iamkelllly iamkelllly commented Oct 30, 2021 •
edited
Loading

Purpose

To update documentation before GA

Changes

  • landing README update: shortened and more concise with branding and diagrams
  • docs site update with landing page "What is Fidesops"
  • Polish on latter 5 guides, cleaning up urls, readability pass, and references
  • Updated favicon

seanpreston
seanpreston reviewed Oct 30, 2021
View reviewed changes
README.md Show resolved Hide resolved
pattisdr
pattisdr reviewed Oct 30, 2021
View reviewed changes
README.md Outdated Show resolved Hide resolved
pattisdr
pattisdr reviewed Oct 30, 2021
View reviewed changes
README.md Show resolved Hide resolved
pattisdr
pattisdr reviewed Oct 30, 2021
View reviewed changes
docs/fidesops/docs/guides/privacy_requests.md Outdated
Take me directly to [api docs](http://0.0.0.0:8080/docs#/Privacy%20Requests/create_privacy_request_api_v1_privacy_request_post).
Take me directly to [API docs](../api/#operations-Privacy_Requests-get_request_status_api_v1_privacy_request_get).
Copy link
Contributor

@pattisdr pattisdr Oct 30, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I must be missing something, where are all of these API links supposed to resolve to? None of these links are working for me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah hm this is not working for me either. Trying to figure out why the ../ isn't moving up the directory. Let me try a few things, but the deeplink should work in this style:
https://ethyca.github.io/fidesops/api#operations-Privacy_Requests-get_request_status_api_v1_privacy_request_get
it's resolving weird though

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @seanpreston , got it updated! ready for merge

@pattisdr
Copy link
Contributor

FYI merged in main @iamkelllly to resolve conflicts since the quickstart was added to the README, and my SAR rename got merged.

@seanpreston
Copy link
Contributor

Thanks for this @iamkelllly

@seanpreston seanpreston merged commit 6049389 into main Oct 31, 2021
@seanpreston seanpreston deleted the kh-docs-update branch October 31, 2021 18:03
sanders41 pushed a commit that referenced this pull request Sep 22, 2022
@iamkelllly @pattisdr
Documentation, README, Branding, and links update (#7)
b349b71 
* updating docs, branding, and readme

* url update

* test update links

* updated with links that work

* replace SAR -> access

Co-authored-by: Dawn Pattison <pattisdr@users.noreply.github.com>
Co-authored-by: Sean Preston <sean@ethyca.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@pattisdr pattisdr Awaiting requested review from pattisdr

@seanpreston seanpreston Awaiting requested review from seanpreston

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@iamkelllly @pattisdr @seanpreston