Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Add a section for industry regulation compliance #6191

Merged
merged 62 commits into from
Dec 19, 2019

Conversation

ccondra
Copy link
Contributor

@ccondra ccondra commented Dec 11, 2019

Purpose of this pull request

The purpose of this PR is to create a new, scalable section in DevDocs for compliance with industry regulations. Compliance is a new option in the main nav under Functional Areas. At this time, Privacy is the only child level under Compliance. However, eventually this section might include Accessibility Security, and any other types of regulations that Magento merchants and developers need to address.

The Privacy section includes topics related to GDPR and the new California Consumer Protection Act (CCPA). The previous GDPR topics have been redirected from Architecture to compliance/privacy, and the dataflow and database entity information has been split off as separate topics for M1 and M2 and agnosticized for any regulation.

The new CCPA topic in DevDocs provides an overview of the developer's role in helping merchants comply with the regulation. The topic links to the user guide for more information about the regulation from a business perspective, and the compliance roadmap for cross-functional teams.

The new section is organized as follows:

Functional Areas (main-nav.yml)
Compliance (compliance.yml)
Industry Compliance (industry-compliance.md)
Privacy Regulations
CCPA (ccpa.md)
GDPR (gdpr.md)
Personal Information Reference (M2) (pi-data-reference-m2.md)
Personal Information Reference (M1) (pi-data-reference-m1.md)

Affected DevDocs pages

Industry Compliance: https://devdocs.magento.com/compliance/industry-compliance.html
CCPA: https://devdocs.magento.com/compliance/privacy/ccpa.html
GDPR: https://devdocs.magento.com/compliance/privacy/gdpr.html
Personal Information References
M1: https://devdocs.magento.com/compliance/privacy/pi-data-reference-m2.html
M2: https://devdocs.magento.com/compliance/privacy/pi-data-reference-m1.html

Additional information

See devdocs staging build 1255 for sign-off.

whatsnew
Created a new Compliance section and added information about CCPA.

Copied existing data flow images to new privacy folder.
Introduction to CCPA and GDPR. These link to agnostic PI Reference topics with data flow and database entity mapping info for M2 & M1.
Agnostic PI Reference topics with data flow and database entity mapping info for M2 & M1.
Parent toipc for new Compliance section.
New Compliance section
Parent topic for new Compliance section.
Overview of developer role on a merdhant's compliance team.
re3named dat5a reference files
Addee greoup: compliance to meta data; updated links to renamed references.
TOC for new Compliance section.
Uploading the SVG data flow images. (The earlier upload included aliases to each image rather than the actual images.)
Corrrected spacing
trying to resolve links
Removed duplicate title; corrected link syntax.
removed commented out links
Removed duplicate title; resolved link syntax issue.
Changed title to Personal Information Reference.
Shortened option name.
Added redirect; changed Personal Informaiton Reference section to match CCPA topic.
reworked sentence (line 17); updated Personal Information Reference section.
Deleted images which were moved to compliance/privacy.
These have been redirected to compliance/privacy topics.
These images were moved to compliance/privacy
cleaned up
Removed space.
Removed site.baseurl syntax
Added blank line after each bullted link.
@dshevtsov
Copy link
Collaborator

@ccondra please do not use a branch name as a title in pull requests. Change the title to be informative for all contributors. It should contain a summary of the changes that are requested to be pulled.

@dshevtsov
Copy link
Collaborator

@ccondra I removed the link to internal preview in PR description. Any use of internal links in public PRs are forbidden. To inform internal contributors, you can use just number of a build or ticket (e.g. Internal ticket: MAGEDOC-98765, or Internal preview build: 6578)

Copy link
Contributor

@keharper keharper left a comment

Choose a reason for hiding this comment

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

Updating note box tags and deleting instances of "Please". All edits are optional.

@dshevtsov
Copy link
Collaborator

dshevtsov commented Dec 18, 2019

@ccondra please change entries in Affected DevDocs pages of the PR description to working URLs pointing to corresponding HTML pages on the devdocs website. You can find examples in other devdocs PRs.

ccondra and others added 11 commits December 19, 2019 07:16
Co-Authored-By: Kevin Harper <keharper@users.noreply.github.com>
Co-Authored-By: Kevin Harper <keharper@users.noreply.github.com>
Co-Authored-By: Kevin Harper <keharper@users.noreply.github.com>
Co-Authored-By: Kevin Harper <keharper@users.noreply.github.com>
Co-Authored-By: Kevin Harper <keharper@users.noreply.github.com>
Updated callout syntax
Fixed callout syntax
Consult with your...
@ccondra
Copy link
Contributor Author

ccondra commented Dec 19, 2019

running tests

1 similar comment
@jeff-matthews
Copy link
Contributor

running tests

@dshevtsov dshevtsov changed the title DOC-33-industry-regulation-compliance Add a section for industry regulation compliance Dec 19, 2019
@jeff-matthews jeff-matthews merged commit 38c8e3c into master Dec 19, 2019
@ghost
Copy link

ghost commented Dec 19, 2019

Hi @ccondra, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@jeff-matthews jeff-matthews deleted the DOC-33-new-compliance-section branch December 19, 2019 19:44
@meker12 meker12 added 2.x 2.2.x 2.3.x Magento 2.3 related changes and removed 2.x labels Jan 28, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
2.2.x 2.3.x Magento 2.3 related changes Internal Dev Differentiates work between community and Magento staff New Topic A major update published as an entirely new document
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants