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

328 improve docs security and privacy page #350

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
27d427c
docs: update privacy & security doc paths
mason-at-pieces Apr 9, 2024
ee05ae0
docs: Update Privacy & Security links
mason-at-pieces Apr 9, 2024
0589e6e
chore: Update redirect rule in vercel.json
mason-at-pieces Apr 9, 2024
24c2013
docs(security-and-privacy): Update content for clarity
mason-at-pieces Apr 9, 2024
a36b0d3
docs: Update compliance section for clarity
mason-at-pieces Apr 9, 2024
3659452
docs: Update security and privacy details
mason-at-pieces Apr 9, 2024
2d99cd1
docs: Add anchor ID to SOC 2 compliance section
mason-at-pieces Apr 9, 2024
74045a4
Merge branch 'main' into 328-improve-docs-security-and-privacy-page
mason-at-pieces Apr 10, 2024
f4ca706
Merge branch 'main' into 328-improve-docs-security-and-privacy-page
mason-at-pieces Apr 10, 2024
eef7010
Merge branch 'main' into 328-improve-docs-security-and-privacy-page
mason-at-pieces Apr 11, 2024
c06ab85
Merge branch 'main' into 328-improve-docs-security-and-privacy-page
mason-at-pieces Apr 12, 2024
ff41493
docs: Add CTAButton import and section in security doc
mason-at-pieces Apr 15, 2024
f28d4ff
docs: Fix markdown formatting in security doc
mason-at-pieces Apr 15, 2024
283100a
Merge branch 'main' into 328-improve-docs-security-and-privacy-page
mason-at-pieces Apr 16, 2024
dbdf490
Merge branch 'main' into 328-improve-docs-security-and-privacy-page
mason-at-pieces Apr 17, 2024
d3722be
Merge branch 'main' into 328-improve-docs-security-and-privacy-page
mason-at-pieces Apr 23, 2024
52d8446
Merge branch 'main' into 328-improve-docs-security-and-privacy-page
mason-at-pieces May 13, 2024
2c3acc3
Merge branch 'main' into 328-improve-docs-security-and-privacy-page
mason-at-pieces May 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/extensions-plugins/azure-data-studio.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ This setting enables automatic copying for generated Pieces links. If enabled, y
If you choose to enable auto-save, Pieces will automatically save highly re-used and potentially useful snippets while you work. This cuts down on the number of snippets you need to save manually and helps to prevent searching for code in all of your files.

### Cloud Capabilities
Here you can choose which type of ML models you'd like to use in Pieces for Azure Data Studio: Cloud, Local, or Blended. To learn more about the types of ML models and their privacy implications, [visit this section of our documentation](/product-highlights-and-benefits/privacy-security-data#our-machine-learning-models).
Here you can choose which type of ML models you'd like to use in Pieces for Azure Data Studio: Cloud, Local, or Blended. To learn more about the types of ML models and their privacy implications, [visit this section of our documentation](/security-and-privacy#our-machine-learning-models).

### Display
In this section, you can choose what aspect of your snippets to display in the snippet list.
Expand Down
2 changes: 1 addition & 1 deletion docs/extensions-plugins/visual-studio.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ You can generate a shareable link for a code snippet by selecting the code you w
This setting enables automatic copying for generated Pieces links. If enabled, you won't need to copy a Pieces link before sharing it with a teammate or friend.

### Cloud Capabilities
Here you can choose which type of ML models you'd like to use in Pieces for Visual Studio: Cloud, Local, or Blended. To learn more about the types of ML models and their privacy implications, [visit this section of our documentation](/product-highlights-and-benefits/privacy-security-data#our-machine-learning-models).
Here you can choose which type of ML models you'd like to use in Pieces for Visual Studio: Cloud, Local, or Blended. To learn more about the types of ML models and their privacy implications, [visit this section of our documentation](/security-and-privacy#our-machine-learning-models).

### Custom Pieces OS URL
If you're using a [custom Pieces OS URL](/product-highlights-and-benefits/connecting-to-a-remote-pieces-os-instance), you can update it here. This is useful if you're using a self-hosted version of Pieces OS.
Expand Down
2 changes: 1 addition & 1 deletion docs/extensions-plugins/vscode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ This setting enables automatic copying for generated Pieces links. If enabled, y
If you choose to enable auto-save, Pieces will automatically save highly re-used and potentially useful snippets while you work. This cuts down on the number of snippets you need to save manually and helps to prevent searching for code in all of your files.

### Cloud Capabilities
Here you can choose which type of ML models you'd like to use in Pieces for VS Code: Cloud, Local, or Blended. To learn more about the types of ML models and their privacy implications, [visit this section of our documentation](/product-highlights-and-benefits/privacy-security-data#our-machine-learning-models).
Here you can choose which type of ML models you'd like to use in Pieces for VS Code: Cloud, Local, or Blended. To learn more about the types of ML models and their privacy implications, [visit this section of our documentation](/security-and-privacy#our-machine-learning-models).

### Display
In this section, you can choose what aspect of your snippets to display in the snippet list.
Expand Down
4 changes: 2 additions & 2 deletions docs/features/user-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -260,12 +260,12 @@ You can choose to use local or blended processing to manage your code snippets.

Try both modes to find what works best in your environment.

**Note:** Choosing local-only processing ensures that your code remains solely on your device. Learn more about [Privacy & Data Security](/product-highlights-and-benefits/privacy-security-data) at Pieces to determine which processing mode is best for you.
**Note:** Choosing local-only processing ensures that your code remains solely on your device. Learn more about [Privacy & Security](/security-and-privacy) at Pieces to determine which processing mode is best for you.

## Telemetry
You can always adjust the amount of anonymous data that you share with us. By unchecking this box, you ensure that we will not collect data and analytics from your machine. Regardless of collection preferences, we do not collect your code snippets! They are stored on your machine. The data we collect helps us see how often particular actions are taken, what sections of the application are used by the community as a whole, and other data so that we can provide a better experience for you. Personal data is not collected and your code is not shared with any other parties, even when you generate shareable links.

Read more about our [Privacy & Data Security](/product-highlights-and-benefits/privacy-security-data) to get a full look.
Read more about our [Privacy & Security](/security-and-privacy) to get a full look.

## Information
To share the version number and specific platform build of your version of the Pieces Desktop App, just press the copy button next to either of these items. These are helpful when working with Support on installation and debugging issues.
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,32 @@ title: Privacy, Security & Your Data
description: Let's jump in and touch on privacy, data, cloud-based features, and our ML models.
---

# Privacy, Security, & Your Data
From Day 1 of engineering Pieces for Developers, we've had a first principle that everything is local first and built with speed, privacy, security, and offline-productivity in mind.
import CTAButton from "../src/components/CTAButton";

We also know that our partners **operate in highly secure and sensitive environments**, and we want to be prepared to operate in such environments, e.g., HIPAA, SOC 2, FERPA/COPPA, etc. That being said - we can't tell you how happy we are that we have stayed true to this philosophy for cases just like yours!
From day 1 of building Pieces for Developers, we've had a first principle that everything is local first and built with speed, privacy, security, and offline-productivity in mind.

## Where Snippets are Stored
Your snippets are stored completely locally on your device. This is what the path looks like for an installation on macOS:
We also know that our partners **operate in highly secure and sensitive environments**, and we want to be prepared to operate in such environments (HIPAA, SOC 2, FERPA/COPPA, etc.). That being said - we can't tell you how happy we are that we have stayed true to this philosophy for cases just like yours!

### macOS
## We are SOC 2 Compliant 🔒 {#we-are-soc-2-compliant}

`/Users/[YOUR-USERNAME]/Library/com.pieces.os/`

### Windows

`C:/Users/[YOUR-USERNAME]/Documents/com.pieces.os/`

### Linux

`/Users/[YOUR-USERNAME]/Documents/com.pieces.os/`

You can easily copy this directory to a flash drive and bring it to another computer.
SOC 2 is a prestigious benchmark in the tech industry, especially important for companies like ours. It verifies that we meet strict organizational controls and practices, enhancing our credibility and trustworthiness in the market.

This achievement is a collective triumph for our team, reflecting our dedication to maintaining a secure and reliable service. It's an essential step forward in our mission to provide word class developer tools.

## We are SOC 2 Compliant!
<CTAButton
href={'https://getpieces.typeform.com/to/WVEvvJkx'}
label={'Request our SOC 2 Report'}
type={'secondary'}
/>

![SOC 2 Compliance Badge](/assets/soc-2-badge.png)
## Our Machine Learning Models
Pieces has our own internal ML models that we use to power some of our features. We have a few different models, and they are all built with privacy and security in mind.

SOC 2 is a prestigious benchmark in the tech industry, especially important for companies like ours. It verifies that we meet strict organizational controls and practices, enhancing our credibility and trustworthiness in the market.
:::info Local Processing

This achievement is a collective triumph for our team, reflecting our dedication to maintaining a secure and reliable service. It's an essential step forward in our mission to provide word class developer tools.
Our ML models are designed to function entirely offline and on-device, eliminating the need for internet connectivity. This is possible by opting out of blended processing, as the models are integrated within the application's binary, ensuring seamless operation without requiring an internet connection.

## Our Machine Learning Models
Our ML models can be completely local and offline (i.e., they're shipped within the application's binary & require no internet) as long as you opt out of blended processing.
:::

If you have **not opted out of blended processing,** then some of the models will offload computation to the cloud. A few of our models are **only** available in the cloud, but we are working on making them local.

Expand All @@ -59,13 +52,12 @@ This table shows which models are available locally and which will use cloud com
| Tag Generation | ✅ | ✅ |
| Title Generation | ✅ | ✅ |


Our ML models are not trained continuously. They do not train on your data as you use the product!
Our ML models are not trained continuously. **They do not train on your data** as you use the product.

## Saving Code Snippets in the Cloud
The Pieces cloud is entirely opt-in. Authentication is managed by our enterprise-ready authentication partners at Auth0 (now owned by Okta).

Even when a user signs in, they do not have a cloud until they specifically connect it in their Settings.
Even when a user signs in, they do not have a cloud until they specifically connect it in their [settings](/features/user-settings#private-cloud-beta).

If a user opts into the cloud, the data is only uploaded when something is shared.

Expand All @@ -79,12 +71,12 @@ Finally, a note on cloud architecture for the things that are backed up:
Every user's cloud scales up and down completely independent of other users. The cloud is only running when a shared snippet is being accessed, backed up, or updated, and we can easily port our docker images over to an existing "Panasonic Cloud" if needed.

## Telemetry & Crash Data
Most importantly, all data collection is opt-out and we give all the control to our users.
Most importantly, all data collection is opt-out, and we give all the control to our users.

The data that we do collect is completely anonymous and highly secure (we take data very seriously).

### Why do we collect data?
Long story short, we're a seed stage startup and the data helps us to report on overall growth and hopefully help us earn more funding.
Long story short, we're an early-stage startup and the data helps us to report on overall growth and hopefully earn more funding to continue building amazing products for our users.

Here are some screenshots of Telemetry opt-outs from the Pieces products:

Expand Down
4 changes: 4 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,10 @@ const config: Config = {
{
title: 'Terms & Policies',
items: [
{
label: 'Security & Privacy',
href: '/security-and-privacy',
},
{
label: 'Privacy Policy',
href: '/privacy-policy',
Expand Down
10 changes: 5 additions & 5 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -160,11 +160,6 @@ const sidebars: SidebarsConfig = {
id: 'product-highlights-and-benefits/in-project-snippet-discovery',
label: 'In-Project Snippet Discovery',
},
{
type: 'doc',
id: 'product-highlights-and-benefits/privacy-security-data',
label: 'Privacy & Security',
},
{
type: 'doc',
id: 'product-highlights-and-benefits/sync-across-multiple-devices-using-github',
Expand Down Expand Up @@ -232,6 +227,11 @@ const sidebars: SidebarsConfig = {
id: 'support',
label: 'Support',
},
{
type: 'doc',
id: 'security-and-privacy',
label: 'Security & Privacy',
},
{
type: 'doc',
id: 'faq',
Expand Down
5 changes: 5 additions & 0 deletions vercel.json
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,11 @@
"destination": "/product-highlights-and-benefits/saving-to-and-from-github-gists",
"statusCode": 301
},
{
"source": "/product-highlights-and-benefits/privacy-security-data",
"destination": "/security-and-privacy",
"statusCode": 301
},
{
"source": "/frequently-asked-questions",
"destination": "/faq",
Expand Down