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

[#716] update datastore documentation #742

Merged
merged 4 commits into from
Jun 28, 2022
Merged

Conversation

conceptualshark
Copy link
Contributor

@conceptualshark conceptualshark commented Jun 27, 2022

Purpose

Complete the datastore connection documentation to match what's finished in the UI.

Changes

  • updated the old datastore image with the current state
  • added additional images and docs around datastore management: panel use, testing connections, disabling/deleting datastores

Checklist

  • Update CHANGELOG.md file
    • Merge in main so the most recent CHANGELOG.md file is being appended to
    • Add description within the Unreleased section in an appropriate category. Add a new category from the list at the top of the file if the needed one isn't already there.
    • Add a link to this PR at the end of the description with the PR number as the text. example: #1
  • Applicable documentation updated (guides, quickstart, postman collections, tutorial, fidesdemo, database diagram.
  • If docs updated (select one):
    • documentation complete, or draft/outline provided (tag docs-team to complete/review on this branch)

Ticket

Fixes #716

@conceptualshark conceptualshark marked this pull request as ready for review June 27, 2022 20:59
@adriaaaa
Copy link

@conceptualshark reviewed the above and it looks great! Just a couple of things:

  • update spelling of "pagenated" to "paginated"
  • is it "reenabled" or "re-enabled"?
  • this sentence "For systems with larger collections of datastores, search options are available to filter results." The way I read it implies that search options are only available for larger collections of datastores. Maybe we can reword it a little to imply that search options are available to help them find the datastore they are looking for?
  • For the testing datastores section, not sure if you purposely left out the "grey" connection option or not but that color implies that the creds haven't been tested yet to confirm if it passed or failed.

@conceptualshark
Copy link
Contributor Author

@conceptualshark reviewed the above and it looks great! Just a couple of things:

* update spelling of "pagenated" to "paginated"

* is it "reenabled" or "re-enabled"?

* this sentence "For systems with larger collections of datastores, search options are available to filter results." The way I read it implies that search options are only available for larger collections of datastores. Maybe we can reword it a little to imply that search options are available to help them find the datastore they are looking for?

* For the testing datastores section, not sure if you purposely left out the "grey" connection option or not but that color implies that the creds haven't been tested yet to confirm if it passed or failed.

Thank you for the quick review! Should have resolved all of these. 👍

@conceptualshark conceptualshark merged commit 44017b3 into main Jun 28, 2022
@conceptualshark conceptualshark deleted the cg-datastore-screenshots branch June 28, 2022 14:16
sanders41 pushed a commit that referenced this pull request Sep 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Datastore Management doc page with a different screenshot
2 participants