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.

Sign up for GitHub

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

Jump to bottom

RUMM-924 Add Data Scrubbing and GDPR docs #377

Merged

ncreated merged 42 commits into release/1.5.0 from ncreated/RUMM-924-add-data-scrubbing-and-gdpr-docs

Mar 4, 2021

Member

ncreated commented Jan 19, 2021

What and why?

🎓 This PR updates docs with recent APIs introduced since 1.4.x: tracking consent and data scrubbing.

How?

To align it a bit more with dd-sdk-android docs:

I created separate gdpr.md doc,
added Tracking Consent API description in all feature docs (Logging / Tracing / RUM),
added Data Scrubbing section in RUM docs,
added picture and link to RUM docs in repository's README.md.

Review checklist

Feature or bugfix MUST have appropriate tests (unit, integration)
Make sure each commit and the PR mention the Issue number or JIRA reference
Merge to / after release/1.5.0 is issued

ncreated self-assigned this

ncreated requested review from a team as code owners

January 19, 2021 13:24

acgh reviewed

View reviewed changes

docs/rum_collection.md Outdated Show resolved Hide resolved

acgh reviewed

View reviewed changes

docs/rum_collection.md Outdated Show resolved Hide resolved

acgh reviewed

View reviewed changes

docs/rum_collection.md Outdated Show resolved Hide resolved

acgh reviewed

View reviewed changes

docs/rum_collection.md Outdated Show resolved Hide resolved

acgh reviewed

View reviewed changes

Contributor

acgh left a comment

This looks great to me! I have suggested a few grammar/wording edits but they are minor.
I'm going to give the chance to more reviewers to have a look at this PR before approving.

cswatt requested changes

View reviewed changes

Contributor

cswatt left a comment

a few styleguide changes

docs/gdpr.md Outdated Show resolved Hide resolved

docs/gdpr.md Outdated Show resolved Hide resolved

docs/gdpr.md Outdated Show resolved Hide resolved

docs/log_collection.md Outdated Show resolved Hide resolved

docs/log_collection.md Outdated Show resolved Hide resolved

docs/rum_collection.md Outdated Show resolved Hide resolved

docs/rum_collection.md Outdated Show resolved Hide resolved

docs/trace_collection.md Outdated Show resolved Hide resolved

docs/trace_collection.md Outdated Show resolved Hide resolved

docs/trace_collection.md Outdated Show resolved Hide resolved

ncreated requested a review from cswatt

January 26, 2021 17:30

Member Author

ncreated commented Jan 26, 2021

Thank you @cswatt - very consistent feedback 👌. All is applied now, please have another look 🙏 🙂.

buranmert reviewed

View reviewed changes

docs/log_collection.md Show resolved Hide resolved

Alexandre Costanza added 18 commits

February 2, 2021 14:37


          RUMM-1000 Fix typo defaultVaule -> defaultValue

e104a4e


          RUMM-1000 Add additionalProperties to JSONSchema and JSONObject

4f1e077


          RUMM-1000 Add additionalProperties to SwiftType and read them in JSON…

5cacf26

…ToSwiftTypeTransformer


          RUMM-1000 Make SwiftStruct.additionalProperties go through the RUM Sw…

ebd5797

…iftType transformer


          RUMM-1000 Make SwiftPrinter print SwiftStruct.additionalProperties

ee0d7df


          RUMM-1000 Change remaining mentions of managedSwift to bridgedSwift

bd6c2b1


          RUMM-1000 Handle PropertyWrappers for SwiftStruct additionalPropertie…

4b02c71

…s in Objc Interop


          RUMM-1000 Generate Codable methods in SwiftPrinter for Structs with a…

865c881

…dditionalProperties


          RUMM-1000 Add basic support of Dictionary as SwiftType/ObjcInteropTyp…

d6e7c67

…e and use it for additionalProperties


          RUMM-1000 Remove exclusion of customTimings in RUMSwiftTypeTransforme…

7c60dcd

…r after adding support for additionalProperties


          RUMM-1000 Move mapping from Property to Dictionary of Properties for …

efe10d9

…additional properties to a later stage in RUMSwiftTypeTransformer


          RUMM-1000 Add comments and factor some functions

f3bbb6d


          RUMM-1000 Factor some more code

a0e6b81


          RUMM-1000 Add back exclusion of customTimings to be addressed in a de…

afbf154

…dicated PR


          RUMM-1000 Lint

ab61310


          RUMM-1000 Exclude DynamicCodingKeys by default in SwiftPrinter until …

41a1ac8

…we introduce a model with addional properties


          RUMM-1000 Backtrack on the approach and model JSONSchemas with additi…

8e6fbbf

…onalProperties as simple Swift Dictionaries


          RUMM-1000 Lint

e43c911

acgh and others added 11 commits

February 8, 2021 15:20


          Merge pull request #399 from DataDog/acgh/rumm-1000-support-custom-ti…

d61fd7b

…mings-json-schema

RUMM-1000 Add support for additional properties to the models generation pipeline


          RUMM-1000 Remove filter on customTimings in RUM SwiftTypes Transformer

423f095


          RUMM-1000 Run rum-models-generator and generate customTimings and nam…

8b70eab

…e for the View model


          RUMM-1018 Create a dogfooding script

4f9ef08


          RUMM-1000 Remove RUMEvent.customViewTimings + the related workarounds…

d829781

… and use View.customTimings instead


          RUMM-1000 Revert tests added for workarounds in #147

f6b5cbf


          RUMM-1000 Fix benchmark tests

318d9b5


          Merge pull request #406 from DataDog/acgh/rumm-1000-use-view-custom-t…

3389fe5

…imings-from-schema

RUMM-1000 Use View.customTimings from actual schema instead of RUMEvent


          Updated Swift testing version number

c83e61d


          Merge pull request #408 from DataDog/nachoBonafonte/update-to-0.6.0-t…

3507cae

…esting-sdk

Update to dd-sdk-testing-swift version 0.6.0


          RUMM-1018 Use bundle exec pod install to ensure a proper Podfile.lock…

2bd8a20

… file

cswatt approved these changes

View reviewed changes

bpollman and others added 3 commits

February 15, 2021 09:08


          Swift Package Manager - Add static library variant's to allow use ins…

fc961b7

…ide nested frameworks


          Merge pull request #404 from DataDog/xgouchet/RUMM-1018/dogfooding

5eb0b69

RUMM-1018 Create a dogfooding script


          Merge pull request #405 from bpollman/1.4.1-remove-dynamic

4e952d3

Swift Package Manager - Add static library variants to allow use inside frameworks

acgh reviewed

View reviewed changes

docs/rum_collection.md Show resolved Hide resolved

acgh suggested changes

View reviewed changes

Contributor

acgh left a comment

To align with RUMM-1077, we need to add a special case for RUMViewEventMapper in the paragraph about mappers, as it will return a non-optional type as opposed to the other kinds of mappers.

ncreated and others added 8 commits

February 19, 2021 10:42


          RUMM-924 Add gdpr.md

66898c3


          RUMM-924 Add data scrubbing doc

75664b7


          RUMM-924 Update Logs, Traces and RUM docs with trackingConsent API

830a0bd


          RUMM-924 Update table of contents in docs/README.md

81788e9


          RUMM-924 Update README.md with image and link to RUM docs

325bfb9


          RUMM-924 CR fix: wording

78e6a08

Co-authored-by: Alex Costanza <acgh@users.noreply.github.com>


          RUMM-924 Apply suggestions from code review

454adc5

Co-authored-by: cswatt <cecilia.watt@datadoghq.com>


          RUMM-924 Add notes on recent changes made in #415 and #418

1d65b6d

ncreated force-pushed the ncreated/RUMM-924-add-data-scrubbing-and-gdpr-docs branch from e50a9ae to 1d65b6d Compare

February 19, 2021 09:46

ncreated mentioned this pull request

Release 1.5.0 #430

Merged

2 tasks

ncreated changed the base branch from master to release/1.5.0

March 4, 2021 09:18

ncreated merged commit abf6bc8 into release/1.5.0

ncreated deleted the ncreated/RUMM-924-add-data-scrubbing-and-gdpr-docs branch

March 4, 2021 09:18

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet