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

Ck documentation structure changes #167

Merged
merged 28 commits into from
Oct 18, 2021
Merged

Conversation

cilliankieran
Copy link
Contributor

Changes to Fides documentation including:

  • Restructure of navigation and page sections
  • Updated overview and introduction to Fides
  • New language and taxonomy section
  • Addition of visual taxonomy explorer
  • Changes to links and relationships between multiple pages to accomodate navigation update.

Code Changes

  • Updated docs/fides/makdocs.yml
  • Updated docs/fides/docs/index.md
  • Consolidated all css to docs/fides/docs/css/fides.css
  • Deleted docs/fides/docs/css/stylesheet.css
  • Added new image assets to docs/fides/docs/img
  • Added csv of taxonomy to docs/fides/docs/csv:
    • docs/fides/docs/csv/data_categories.csv
    • docs/fides/docs/csv/data_qualifiers.csv
    • docs/fides/docs/csv/data_subjects.csv
    • docs/fides/docs/csv/data_uses.csv
  • docs/fides/docs/js/vis.js
  • Added docs/fides/docs/language and related pages:
    • docs/fides/docs/language/overview.md
    • docs/fides/docs/language/syntax.md
    • docs/fides/docs/language/syntax.md
    • docs/fides/docs/language/taxonomy:
      • docs/fides/docs/language/taxonomy/data_categories.md
      • docs/fides/docs/language/taxonomy/data_identification_qualifiers.md
      • docs/fides/docs/language/taxonomy/data_subject_categories.md
      • docs/fides/docs/language/taxonomy/data_use_categories.md
      • docs/fides/docs/language/taxonomy/explorer.md
      • docs/fides/docs/language/taxonomy/overview.md

Steps to Confirm

  • Run make doss-serve locally and review documentation on all pages.

Pre-Merge Checklist

  • All CI Pipelines Succeeded
  • Documentation Updated

Description Of Changes

This was a consolidation of a rebased master with some conflicts, please review carefully to ensure no outstanding issues.

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 all this- I did a pass through for some copy edits and tweaks and pushed several updates. I tried to leave comments along the way to take notes but lost track of some of them!

I still have some more files to edit and review but want to pause here for now and will pick this up again in a bit. We shouldn't merge this quite yet

docs/fides/docs/ethyca.md Outdated Show resolved Hide resolved
docs/fides/docs/language/overview.md Show resolved Hide resolved
docs/fides/docs/language/overview.md Show resolved Hide resolved
docs/fides/docs/language/taxonomy/explorer.md Show resolved Hide resolved
docs/fides/docs/language/overview.md Outdated Show resolved Hide resolved
docs/fides/docs/language/syntax.md Show resolved Hide resolved
docs/fides/docs/language/taxonomy/data_categories.md Outdated Show resolved Hide resolved
docs/fides/docs/language/taxonomy/data_categories.md Outdated Show resolved Hide resolved
docs/fides/docs/language/taxonomy/overview.md Outdated Show resolved Hide resolved
docs/fides/docs/language/taxonomy/overview.md Outdated Show resolved Hide resolved
docs/fides/docs/principles.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@cilliankieran cilliankieran left a comment

Choose a reason for hiding this comment

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

There's a few open items here that it'd be good to discuss @NevilleS / @iamkelllly and then we can hopefully finalize this.
I do need to get a copy of this into general privacy-taxonomy repo shortly too so it'd be helpful to bottom out.

docs/fides/docs/language/overview.md Outdated Show resolved Hide resolved
docs/fides/docs/language/overview.md Show resolved Hide resolved
docs/fides/docs/language/overview.md Show resolved Hide resolved
docs/fides/docs/language/syntax.md Show resolved Hide resolved
docs/fides/docs/language/taxonomy/data_categories.md Outdated Show resolved Hide resolved
docs/fides/docs/language/taxonomy/data_categories.md Outdated Show resolved Hide resolved
docs/fides/docs/language/taxonomy/overview.md Outdated Show resolved Hide resolved
docs/fides/docs/language/taxonomy/overview.md Outdated Show resolved Hide resolved
docs/fides/docs/principles.md Outdated Show resolved Hide resolved
@NevilleS NevilleS merged commit 7e78318 into main Oct 18, 2021
@NevilleS NevilleS deleted the ck-documentation-structure-changes branch October 18, 2021 13:56
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.

3 participants