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

Add Experience Config docs #5405

Merged
merged 3 commits into from
Oct 24, 2024
Merged

Conversation

gilluminate
Copy link
Contributor

@gilluminate gilluminate commented Oct 22, 2024

Closes HJ-14

Description Of Changes

Add new documentation for Fides.experience.experience_config object.

Customers are already relying on these properties for some of their own, client-side logic. As such, we want to carve out a defined set of documented fields on the Fides.experience object that customers can rely on that won’t be broken in future updates.

As a final step we should run npm run docs:import in our fidesdocs project to import these docs into the FidesJS SDK Reference section.

Pre-Merge Checklist

  • All CI Pipelines Succeeded
  • Documentation:
  • Issue Requirements are Met
  • Update CHANGELOG.md

@gilluminate gilluminate requested a review from NevilleS October 22, 2024 21:40
Copy link

vercel bot commented Oct 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
fides-plus-nightly ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 24, 2024 0:40am

@gilluminate gilluminate force-pushed the HJ-14-docs-update-fides-js-developer branch 2 times, most recently from 7e25e9c to f7027bc Compare October 22, 2024 21:53
Copy link

cypress bot commented Oct 22, 2024

fides    Run #10598

Run Properties:  status check passed Passed #10598  •  git commit 7767944776 ℹ️: Merge 2af552cf1349b5a142043e1d749d9f33237484ab into 71e87267d6d3fea57ed87d4bdb70...
Project fides
Branch Review refs/pull/5405/merge
Run status status check passed Passed #10598
Run duration 00m 38s
Commit git commit 7767944776 ℹ️: Merge 2af552cf1349b5a142043e1d749d9f33237484ab into 71e87267d6d3fea57ed87d4bdb70...
Committer Jason Gill
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 4
⚠️ You've recorded test results over your free plan limit.
Upgrade your plan to view test results.
View all changes introduced in this branch ↗︎

@gilluminate gilluminate force-pushed the HJ-14-docs-update-fides-js-developer branch from f7027bc to 6c4a041 Compare October 22, 2024 21:56
@Kelsey-Ethyca Kelsey-Ethyca merged commit b45bb2a into main Oct 24, 2024
13 checks passed
@Kelsey-Ethyca Kelsey-Ethyca deleted the HJ-14-docs-update-fides-js-developer branch October 24, 2024 00:57
Kelsey-Ethyca added a commit that referenced this pull request Oct 24, 2024
Co-authored-by: Kelsey Thomas <101993653+Kelsey-Ethyca@users.noreply.github.com>
Copy link

cypress bot commented Oct 24, 2024

fides    Run #10600

Run Properties:  status check passed Passed #10600  •  git commit b45bb2a0f5: Add Experience Config docs (#5405)
Project fides
Branch Review main
Run status status check passed Passed #10600
Run duration 00m 38s
Commit git commit b45bb2a0f5: Add Experience Config docs (#5405)
Committer Jason Gill
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 4
⚠️ You've recorded test results over your free plan limit.
Upgrade your plan to view test results.
View all changes introduced in this branch ↗︎

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.

2 participants