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

Documentation updates #91 #145

Merged
merged 15 commits into from
Oct 12, 2021
Merged

Documentation updates #91 #145

merged 15 commits into from
Oct 12, 2021

Conversation

iamkelllly
Copy link
Contributor

@iamkelllly iamkelllly commented Oct 7, 2021

Closes #91

Code Changes

  • Overhaul of tutorial
  • Add light styling to docs portal
  • Small updates to README lander
  • Placeholder for CI reference guide

Steps to Confirm

  • Checked docs locally

Pre-Merge Checklist

  • All CI Pipelines Succeeded
  • Documentation Updated

Description Of Changes

A few todos in there, I'll bump folks directly for input on these.

- Overhaul of tutorial
- Add light styling to docs portal
- Small updates to README lander
- Placeholder for CI reference guide
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/fides/docs/tutorial/policy.md Show resolved Hide resolved
docs/fides/docs/ci_reference.md Show resolved Hide resolved
docs/fides/docs/tutorial/dataset.md Outdated Show resolved Hide resolved
docs/fides/docs/tutorial/dataset.md Outdated Show resolved Hide resolved
docs/fides/docs/getting_started/docker.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@NevilleS NevilleS left a comment

Choose a reason for hiding this comment

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

Thanks for doing this. I added a bunch of notes to see how this feels when we tidy it up.

However, I'm still not sure we've got the right content here; these feel like replays of the demo resources with more information about each type (which is super helpful) but without some clear recommendations for how an engineer would approach creating declarations for their own systems?

docs/fides/docs/tutorial/ci.md Outdated Show resolved Hide resolved
docs/fides/docs/getting_started/docker.md Show resolved Hide resolved
docs/fides/docs/tutorial/dataset.md Outdated Show resolved Hide resolved
docs/fides/docs/tutorial/dataset.md Outdated Show resolved Hide resolved
docs/fides/docs/tutorial/dataset.md Show resolved Hide resolved
docs/fides/docs/tutorial/evaluate.md Show resolved Hide resolved
docs/fides/docs/tutorial/policy.md Show resolved Hide resolved
docs/fides/docs/tutorial/system.md Outdated Show resolved Hide resolved
docs/fides/docs/tutorial/taxonomy.md Show resolved Hide resolved
docs/fides/docs/tutorial/taxonomy.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/fides/docs/getting_started/docker.md Show resolved Hide resolved
docs/fides/docs/tutorial/ci.md Outdated Show resolved Hide resolved
docs/fides/docs/tutorial/taxonomy.md Outdated Show resolved Hide resolved
docs/fides/docs/tutorial/ci.md Show resolved Hide resolved
docs/fides/docs/tutorial/dataset.md Outdated Show resolved Hide resolved
docs/fides/docs/tutorial/dataset.md Outdated Show resolved Hide resolved
docs/fides/docs/getting_started/docker.md Show resolved Hide resolved
docs/fides/docs/tutorial/system.md Show resolved Hide resolved
@NevilleS
Copy link
Contributor

NevilleS commented Oct 8, 2021

Pushed some CSS fixes, hopefully this is what you were going for

added examples of plain-english policy
reverting to main
reverting to main
@iamkelllly
Copy link
Contributor Author

Alright ready for re-review @NevilleS so we can merge asap. There are only a couple todos in there, but it will get us to the next push from @dougfulton on fides_resources documentation

@iamkelllly iamkelllly assigned iamkelllly and unassigned dougfulton Oct 12, 2021
@iamkelllly iamkelllly requested a review from NevilleS October 12, 2021 03:23
@NevilleS NevilleS assigned NevilleS and unassigned iamkelllly Oct 12, 2021
Copy link
Contributor

@NevilleS NevilleS left a comment

Choose a reason for hiding this comment

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

Looking good. Pushed a few changes to fix some things like broken links

README.md Show resolved Hide resolved
docs/fides/docs/index.md Show resolved Hide resolved
docs/fides/docs/taxonomy.md Show resolved Hide resolved
docs/fides/docs/tutorial/dataset.md Show resolved Hide resolved
docs/fides/docs/tutorial/dataset.md Show resolved Hide resolved
docs/fides/docs/tutorial/overview.md Show resolved Hide resolved
docs/fides/docs/tutorial/overview.md Show resolved Hide resolved
docs/fides/docs/tutorial/overview.md Show resolved Hide resolved
docs/fides/docs/tutorial/system.md Show resolved Hide resolved
docs/fides/mkdocs.yml Show resolved Hide resolved
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.

Integrate docs generated from source
5 participants