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.

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

privacy-policy-and-control-plane-api #613

Merged
merged 1 commit into from
Dec 27, 2023
Merged

privacy-policy-and-control-plane-api #613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions docs/home/data-privacy-details.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Data Privacy

Run:ai [SaaS Cluster installation](../admin/runai-setup/installation-types.md) uses the Run:ai cloud as its control plane. The cluster sends information to the cloud for the purpose of control as well as dashboards. The document below is a run-down of the data that is being sent to the Run:ai cloud.
Run:ai [SaaS Cluster installation](../admin/runai-setup/installation-types.md) uses the Run:ai cloud as its control plane. The cluster sends information to the cloud for control as well as analytics. The document below is a run-down of the data that is being sent to the Run:ai cloud.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Microsoft.Terms] Prefer 'cloud' over 'the cloud'.

Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Microsoft.Vocab] Verify your use of 'as well as' with the A-Z word list.

Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'that's' instead of 'that is'.

Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Microsoft.Passive] 'being sent' looks like passive voice.



Copy link
Contributor

Choose a reason for hiding this comment

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

[markdownlint-fix] reported by reviewdog 🐶

Suggested change

!!! Note
Expand All @@ -13,7 +13,9 @@ Following is a list of platform data items that are sent to the Run:ai cloud.

| Asset | Data Details |
Copy link
Contributor

Choose a reason for hiding this comment

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

[markdownlint-fix] reported by reviewdog 🐶

Suggested change
| Asset | Data Details |
| Asset | Data Details |

|---------|---------------|
| Job Metrics | Job names, CPU, GPU, and Memory metrics, parameters sent using the `runai submit` command |
| Workload Metrics | Workload names, CPU, GPU, and Memory metrics, parameters sent using the `runai submit` command |
| Workload Assets | Workload [Assets](../Researcher/user-interface/workspaces/blocks/building-blocks.md) such as environments, compute resources and data resoruces |
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'resoruces'?

| Resource Credentials | [Credentials](../admin/admin-ui-setup/credentials-setup.md) to cluster resources are stored and encrypted using a SHA-512 algorithm. The encryption is tenant-specific |
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Microsoft.Passive] 'are stored' looks like passive voice.

Copy link
Contributor

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'SHA' has no definition.

| Node Metrics | Node names and IPs, CPU, GPU, and Memory metrics |
| Cluster Metrics | Cluster names, CPU, GPU, and Memory metrics |
| Projects & Departments | Names, quota information |
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ nav:
- 'Interactive Workloads' : 'developer/cluster-api/reference/interactive.md'
- 'Distributed Training Workloads' : 'developer/cluster-api/reference/distributed.md'
- 'Inference Workloads' : 'developer/cluster-api/reference/inference.md'
- 'Administrator API' : 'developer/admin-rest-api/overview.md'
- 'Control Plane API' : 'developer/admin-rest-api/overview.md'
- 'Metrics API' :
- 'Metrics' : 'developer/metrics/metrics.md'
- 'Deprecated APIs' :
Expand Down