feat(Obfuscation): add obfuscation guidelines
What does this MR do?
Email obfuscation came up in gitlab-org/gitlab!108901 (comment 1239082646) and it looks like it is a new pattern.
This MR documents the pattern decided so we can use it consistently across the product.
Want to use email obfuscation in code?
You can obfuscate emails from any place in the backend application with Gitlab::Utils::Email.obfuscated_email("see@me.com.uk", deform: true)
(maybe , deform: true
can be omitted when we decide we only want to have one version of email obfuscation).
Want to help document other obfuscation patterns?
Contribute to the follow up issue Improve obfuscation guidelines with further exa... (#1520)
Does this MR meet the acceptance criteria?
-
The MR title and commit messages meet the Pajamas commit conventions. -
The “What does this MR do?” section in the MR description is filled out, explaining the reasons for and scope of the proposed changes, per “Say why not just what”. - For example, if the MR is focused on usage guidelines, addressing accessibility challenges could be added in a separate MR.
-
Relevant label(s) are applied to the MR. -
The MR is added to a milestone. -
If creating a new component page from scratch, it follows the page template structure. -
Content follows the Pajamas voice and tone guidelines, falling back on the GitLab Documentation Style Guide when needed. -
Related pages are cross-linked, where helpful. Component pages have related components and patterns defined in their Markdown front matter. -
If embedding a Figma file, it follows the Figma embed guide. -
Review requested from any GitLab designer or directly from a maintainer or trainee maintainer.
Links
Merge request reports
Activity
changed milestone to %15.9
added Pajamas label
assigned to @danmh
- Resolved by Amelia Bauerly
@gitlab-com/gitlab-ux/designers
here is a MR to add some guidelines and patterns around obfuscating data.I wonder if you have any other examples or patterns that might be good candidates to document on this page? Either now or in follow up issues/MRs. Thanks!
- Resolved by Amelia Bauerly
@danmh - please see the following guidance and update this merge request.1 Error Please add typebug typefeature, or typemaintenance label to this merge request.
mentioned in issue danmh/danmh#16 (closed)
added pajamasdefine label
added typeignore label
- Resolved by Dan MH
- Resolved by Dan MH
- Resolved by Dan MH
- Resolved by Marc Saleiko
I don't know whether we display method calls in the Pajamas documentation. If that's the case, we could add that you can obfuscate emails from any place in the backend application with
Gitlab::Utils::Email.obfuscated_email("see@me.com.uk", deform: true)
(maybe, deform: true
can be omitted when we decide we only want to have one version of email obfuscation).
- Resolved by Marc Saleiko
@danmh that was quick. Thank you for the immediate action
I left a few suggestions.
- Resolved by Amelia Bauerly
mentioned in issue gitlab-org/incubation-engineering/service-desk/meta#3
- Resolved by Amelia Bauerly
Minor release (conventional commits)This Merge Request will trigger a minor release of Pajamas Design System based on its title.
This will bump the second part of the version number, e.g.
v1.2.3
->v1.3.0
.Generated by
Danger