Skip to content

Commit

Permalink
RK Tutorial Content and Formatting Edits (#307)
Browse files Browse the repository at this point in the history
* fixed bold in tutorial

* fixed incorrect policy issue in #297

I kept the comment with the original one, because I still find it helpful.

* removed excess comment lines

* fixed syntax highlighting

changed yml --> yaml

* removed newline in summary element

* fixing other syntax highlighting issues

Note: this commit also includes how to articles

* Fixed some other syntax highlighting issue

...and a typo from the last commit :(
  • Loading branch information
RobertKeyser authored Jan 5, 2022
1 parent f3648e3 commit 9b34692
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/fides/docs/guides/generate_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ We can invoke the `generate-dataset` by simply providing a connection url for th
```

The result is a resource file with a dataset with collections and fields to represent our schema:
```
```yaml
dataset:
- fides_key: public
organization_fides_key: default_organization
Expand Down
2 changes: 1 addition & 1 deletion docs/fides/docs/guides/scan_resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ flaskr=# SELECT * FROM users;
```

We have fully annotated this schema before with the following dataset resource file:
```
```yaml
dataset:
- fides_key: public
organization_fides_key: default_organization
Expand Down
2 changes: 1 addition & 1 deletion docs/fides/docs/tutorial/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ test_database_url = "postgresql://postgres:postgres@localhost:5432/fidesctl_test

Now that the dependency is included in the project and the configuration is in place, the fidesctl server needs to be told to run. The app uses `docker-compose` to orchestrate resources, so include `fidesctl` as a service by adding the following configuration after the database service:

```yml
```yaml
fidesctl:
image: ethyca/fidesctl:latest
depends_on:
Expand Down
2 changes: 1 addition & 1 deletion docs/fides/docs/tutorial/dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This app contains a single PostgreSQL dataset. Create a `dataset` resource to an

For this project, the file should contain the following configuration:

```yml
```yaml
dataset:
- fides_key: flaskr_postgres_dataset
name: Flaskr Example PostgreSQL Database
Expand Down
6 changes: 3 additions & 3 deletions docs/fides/docs/tutorial/google.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To ensure that the app's policies can account for the data collected by Google A

For this System resource, the file should contain the following configuration:

```yml
```yaml
system:
- fides_key: google_analytics_system
name: Google Analytics
Expand Down Expand Up @@ -73,9 +73,9 @@ system:
data_use: improve
data_subjects:
- customer
# With "IP Anonymization" enabled, IP addresses will be pseudonymized in Google Analytics
# With "IP Anonymization" disabled, IP Addresses will remain identifiable.
# See https://developers.google.com/analytics/devguides/collection/gtagjs/ip-anonymization
data_qualifier: aggregated.anonymized.unlinked_pseudonymized.pseudonymized
data_qualifier: aggregated.anonymized.unlinked_pseudonymized.pseudonymized.identified
```
There are two `privacy_declaration`s defined:
Expand Down
7 changes: 3 additions & 4 deletions docs/fides/docs/tutorial/pass.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,8 @@ There are two options to remedy this situation, and to get the `make fidesctl-ev
1. Modify the Google Analytics implementation such that it becomes compliant with the "Minimize User Identifiable Data" policy

<details>
<summary>Click to see the correct answer</summary><br/>

**Option 2** is the best path forward: the Google Analytics implementation should be modified, not the "Minimize User Identifiable Data" policy resource. The policy resource's configuration is dictated by the app's Privacy Policy, and changes could lead to larger compliance issues throughout the system.
<summary>Click to see the correct answer</summary>
<strong>Option 2</strong> is the best path forward: the Google Analytics implementation should be modified, not the "Minimize User Identifiable Data" policy resource. The policy resource's configuration is dictated by the app's Privacy Policy, and changes could lead to larger compliance issues throughout the system.
</details>

---
Expand All @@ -41,7 +40,7 @@ Open the `flaskr/templates/base.html` file in your favorite editor, and add the

Now that the data collection practices in the Google Analytics script have changed, the associated fidesctl System resource should be updated accordingly. Open the `fides_resources/google_analytics_system.yml` file in your favorite editor, and modify the last line (the `data_qualifier` configuration) so that it reads:

```yml
```yaml
data_qualifier: aggregated.anonymized.unlinked_pseudonymized.pseudonymized
```
Expand Down
2 changes: 1 addition & 1 deletion docs/fides/docs/tutorial/policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Fidesctl's privacy declarations provide rich metadata about systems, the data ca

Define a single Policy by creating a `flaskr_policy.yml` file in the `fides_resources` directory. For this project, the file should contain the following configuration:

```yml
```yaml
policy:
- fides_key: flaskr_policy
name: Flaskr Privacy Policy
Expand Down
2 changes: 1 addition & 1 deletion docs/fides/docs/tutorial/system.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Writing a Fides privacy declaration requires answering the questions: _"What dat

For this project, the file should contain the following configuration:

```yml
```yaml
system:
- fides_key: flaskr_system
name: Flaskr Web Application
Expand Down

0 comments on commit 9b34692

Please sign in to comment.