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

Update Docs #74

Merged
merged 10 commits into from
Sep 3, 2021
Merged

Update Docs #74

merged 10 commits into from
Sep 3, 2021

Conversation

iamkelllly
Copy link
Contributor

@iamkelllly iamkelllly commented Aug 16, 2021

Closes #72

Code Changes

  • remove the quick guide section (replaced by a better proper tutorial on that page)
  • fix the link to the tutorial from homepage
  • update README in /docs to reflect the new method make docs-serve
  • clean up the getting started page, strongly biasing towards docker and making sure that works cleanly
  • write the deployment guide, heavily biasing towards Docker (and adding a "choose your own risk" path or doing it directly)
  • homepage cleanup (index.md)

Steps to Confirm

  • list any manual steps taken to confirm the changes

Pre-Merge Checklist

  • All CI Pipelines Succeeded
  • Documentation Updated

Description Of Changes

Write some things here about the changes and any potential caveats

@ThomasLaPiana
Copy link
Contributor

@iamkelllly is this good to merge now or are there other changes you want in?

@iamkelllly iamkelllly changed the title updating landing readme DRAFT: updating landing readme Aug 18, 2021
@iamkelllly
Copy link
Contributor Author

iamkelllly commented Aug 18, 2021

@ThomasLaPiana sorry! not ready yet, i was trying to find the "draft" button somewhere and i couldn't find it so i just published a PR lol i have a few other things to add so EOD today should be good to review. It's all mostly documentation updates and md cleanup

@ThomasLaPiana
Copy link
Contributor

@iamkelllly no worries! Just wanted to confirm, when its ready for a review and merge just assign me as the reviewer and i'll take that as "its ready" :)

@ThomasLaPiana
Copy link
Contributor

@iamkelllly are you ok to also include changes for #72 here? i can dogpile onto this PR instead of opening a new one and dealing with potential merge conflicts

@ThomasLaPiana ThomasLaPiana changed the title DRAFT: updating landing readme Update Docs Aug 26, 2021
@ThomasLaPiana
Copy link
Contributor

@NevilleS would love to get some feedback on the deployment guide

It's extremely sticky work, and I'm not sure how exactly to take it since there are so many different ways to deploy it...
do I assume they'll want all docker? if so, how is that different from the compose? maybe only some docker?

@ThomasLaPiana ThomasLaPiana mentioned this pull request Aug 28, 2021
9 tasks
finished writing the "five easy steps" though it's really not that easy
Reworded, reorg'ed and reduced repeats
style tings
@iamkelllly iamkelllly merged commit 502200e into main Sep 3, 2021
@iamkelllly iamkelllly deleted the iamkelllly-readme branch September 3, 2021 13:55
ThomasLaPiana pushed a commit that referenced this pull request Aug 17, 2022
* Add foundation to make Redshift access request queries.

* Fix connection config and dataset config tests that look at a new dataset being added.

* Add support for performing redshift erasures.

* Only mask state field in erasure test - contact is too broad, and was preventing the customer record from getting cleaned up.

* Remove unnecessary assertion and access values as attributes of RowProxy not tuples.

* Add Amazon Redshift example to docs.

* Remove breakpoint, argh.

* Use SQLAlchemy TextClause instead of passing in raw string.

* Add request attribute to mask_data and pass into generate_update_stmt.
ThomasLaPiana pushed a commit that referenced this pull request Sep 26, 2022
* Add foundation to make Redshift access request queries.

* Fix connection config and dataset config tests that look at a new dataset being added.

* Add support for performing redshift erasures.

* Only mask state field in erasure test - contact is too broad, and was preventing the customer record from getting cleaned up.

* Remove unnecessary assertion and access values as attributes of RowProxy not tuples.

* Add Amazon Redshift example to docs.

* Remove breakpoint, argh.

* Use SQLAlchemy TextClause instead of passing in raw string.

* Add request attribute to mask_data and pass into generate_update_stmt.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve new developer experience
2 participants