Skip to content

Commit

Permalink
Workspaces launch changes (#254)
Browse files Browse the repository at this point in the history
* Update README.md

* Update welcome-to-workspaces.md

* Update workspaces-for-companies.md

* Update sso.md

* Update roles.md

* Update projects.md

* Update members.md

* Update faqs.md

* Update data-residency.md

* Update data-residency.md

* Update billing.md

* Update README.md

* No Billing details

* Update welcome-to-workspaces.md

* Add Automate details

* Update welcome-to-workspaces.md

* Include Automate

* Automate mentioned!!

* Create advanced-features.md

* Update advanced-features.md

* Update advanced-features.md

* Update config.js

* Update billing.md

* Update roles.md

* Billing clarification from Benjamin

* Adopting PR comments

* Separated Adding and Removing members to be crystal clear

* Default regions

* Default region
  • Loading branch information
jsdbroughton authored Nov 29, 2024
1 parent c136aa9 commit 044ddef
Show file tree
Hide file tree
Showing 12 changed files with 311 additions and 166 deletions.
2 changes: 1 addition & 1 deletion .vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ module.exports = {
sidebarDepth: 0,
title: 'Workspace Docs 👩‍🏭',
collapsable: false,
children: ['', 'welcome-to-workspaces', 'getting-started'],
children: ['', 'welcome-to-workspaces', 'getting-started', 'advanced-features'],
},
{
title: 'Refererences',
Expand Down
12 changes: 4 additions & 8 deletions workspaces/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
# Speckle Workspaces Beta
# Speckle Workspaces

::: tip 🚧 NOTE
Speckle Workspaces is in an accessible beta phase but can be used now on production data. It will be a future paid feature. These docs are a work in progress and are updated regularly.
:::

This mini documentation is designed to assist beta testers of Workspaces, and should be useful for the **Workspace Owner** and **Workspace Member** personas. Your feedback is essential in refining these roles within the platform, enhancing functionality, and ensuring a user-friendly experience.

We will continuously improve these documentation details as things develop; there may be occasions when development outpaces the documentation. If you have any questions, please reach out to us on the [Speckle Community Forum: Making Speckle](https://speckle.community/c/making-speckle/).
Speckle Workspaces is now live and ready for use with production data. This documentation is designed to help **Workspace Owners** and **Workspace Members** navigate and maximise the potential of Workspaces.

Your feedback is invaluable in enhancing functionality and delivering a seamless user experience. While we strive to keep this documentation up-to-date, development may occasionally outpace updates.

If you have any questions or require assistance, please visit the [Speckle Community Forum: Making Speckle](https://speckle.community/c/making-speckle/) (opens new window).
33 changes: 33 additions & 0 deletions workspaces/advanced-features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Advanced Features

Speckle Workspaces unlock advanced features for enhanced team collaboration, workflow automation, and secure project management. By subscribing to a Workspace, teams gain exclusive access to these capabilities to improve efficiency and ensure data control.

## Private Automate Functions

Workspaces provide access to **[Speckle Automate](../automate/)**, enabling teams to create and manage private automation functions securely within their Workspace.

### Key Capabilities:
- **Private Functions**:
- Develop custom automations specific to your team’s workflows.
- These functions are only visible within the Workspace, ensuring confidentiality.

- **Project-Specific Automations**:
- Automations created using private functions can be deployed to projects within the Workspace.
- These are accessible to **Project Reviewers** and above.

- **Role-Based Management**:
- Only **Admins** and **Project Owners** can create and edit automations.
- Contributors and Reviewers can execute automations relevant to their project roles.

### Example Use Cases:
- Automating design review processes by generating reports based on project data.
- Running quality assurance checks to ensure compliance with design standards.
- Streamlining repetitive tasks like updating model metadata across multiple projects.

[Learn More About Speckle Automate](../automate/)

## Expanding Advanced Features

Workspaces will serve as the foundation for introducing additional advanced features. As part of your subscription, you’ll automatically gain access to these as they are released.

Stay updated on planned features and announcements via the [Speckle Community Forum](https://speckle.community).
48 changes: 42 additions & 6 deletions workspaces/billing.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,46 @@
# Billing
# Billing

## Workspaces are free while in beta
Workspaces require a paid subscription to access advanced features, team collaboration tools, and larger-scale operations. This page explains the key billing concepts and operations for managing your Workspace subscription.

While Speckle is offering Workspaces for free during the beta phase, it will be a paid feature in the future. This section will detail the billing and subscription information for Workspaces.
## Trial Period

While in beta, the billing system will give a cost estimate based on the number of members in the workspace. This will be updated to a monthly subscription model in the future.
All new Workspaces begin with a **30-day trial** of the **Starter Plan**. During the trial:
- You can explore all features available in the Starter Plan.
- No credit card information is required.
- At the end of the trial, Workspaces enter **read-only mode** if a subscription is not activated.

Once the beta period ends, workspaces are still free up to 500 model versions.
To store more versions across your projects you will need to upgrade to a paid plan.
## Subscriptions

Subscribe to a paid plan to continue using a Workspace beyond the trial period. All billing and subscription options are managed directly in the Workspace **Settings > Billing** section.

Key points:
- Subscription costs adjust dynamically as you add and remove members.
- When members are removed, their seats remain allocated and billed until the next billing cycle begins.
- Plans and pricing details are displayed directly in the in-app billing section.
- Billing supports both monthly and annual payment options.

## Managing Billing

You can manage your Workspace subscription directly from the in-app billing interface. Available operations include:
- **Upgrading Plans**: Easily switch to higher-tier plans as your needs evolve.
- **Downgrading Plans**: Not yet supported in-app; <a href="'mailto:[email protected]">contact Speckle Support to downgrade</a>.
- **Adding Members**:
- Adding a member **immediately increases the subscription cost** by one seat (if no unoccupied seats are available).
- The cost adjustment is reflected on the next invoice.
- **Removing Members**:
- Removing a member does not immediately lower the subscription cost.
- The seat count remains unchanged for the current billing cycle, and costs will be adjusted based on the current member count at the start of the next billing cycle.

- **Cancelling a Subscription**: Cancel your subscription to stop future charges. Workspaces will enter **read-only mode** after the current billing cycle ends, but all data remains intact.

## Data and Access

When a subscription lapses:
- All Workspace data remains intact and accessible in read-only mode.
- You can only create new versions, add members, or edit once the subscription is reactivated.

## Notes

- The in-app billing section provides detailed pricing and feature comparisons.
- To upgrade, manage members, or adjust your Workspace settings, visit **Settings > Billing** in the Workspace interface.
- For billing-related assistance, contact <a href="'mailto:[email protected]">Speckle Support</a>.
30 changes: 20 additions & 10 deletions workspaces/data-residency.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,31 @@
# Data Residency (Coming Soon)
# Data Residency

Data residency is the concept that data is subject to the laws of the country in which it is located. This is an important consideration for organizations that need to comply with data protection regulations, such as the General Data Protection Regulation (GDPR) in the European Union.
Data residency refers to the concept that data is subject to the laws and regulations of the country in which it is stored. It is an essential consideration for organisations that need to comply with local data protection requirements, such as the General Data Protection Regulation (GDPR) in the European Union.

## Why Data Residency?

Data residency is important because it ensures that organizations can comply with local data protection laws and regulations. For example, while the GDPR requires that personal data of EU citizens is protected to its standards regardless of where it is stored or processed, some jurisdictions, such as Australia, mandate that certain government-related data be stored and processed within the country. By ensuring that data is stored in a specific location, organisations can demonstrate compliance with these regulations.
Data residency helps organisations comply with local data protection laws and regulations.

## Data Residency in Workspaces
For example:
- The GDPR requires that the personal data of EU citizens be protected according to its standards regardless of where it is stored or processed.
- In jurisdictions like Australia, specific government-related data must be stored and processed within the country.

Speckle Workspaces support data residency by allowing organizations to choose the location where their data is stored. This ensures that organizations can comply with local data protection laws and regulations, and have full control over where their data is stored and processed.
Organisations can meet these legal requirements and demonstrate compliance by ensuring data is stored in a specific location.

A Workspace is allocated to the default Speckle region, but organizations have the option to choose a different region. This allows organizations to store their data in a location that complies with local regulations and ensures data residency. An organization may operate multiple Workspaces in different regions to meet the needs of different projects or teams.
## Data Residency in Workspaces

## Restricting access
Speckle Workspaces supports data residency by allowing organisations to choose where their data is stored. This feature helps organisations comply with local regulations while maintaining complete data storage and processing control.

Workspaces is designed to increase the security and privacy of your team's projects while giving greater visibility over who can see and access them. If you have a subset of projects that need to be more secure, you can create a second workspace and invite only the team members who need access to those projects.
- Each Workspace is initially allocated to the default Speckle region.
- Organisations can choose a different region for their Workspace to align with compliance needs.
- Multiple Workspaces can operate in different regions to meet the requirements of various projects or teams.

## Availability
## Restricting Access

Data residency is a premium feature available on the Workspace Business plan.
Workspaces are designed to enhance the security and privacy of your team's projects while clearly displaying who can access them.

- For projects requiring higher security, you can create a separate Workspace and invite only the team members who need access to those projects.

## Availability

If no region is specified or required, your Personal and Workspace project data is automatically assigned to one of Speckle's default regions, optimised for server efficiency and minimal latency. Data residency is a **premium feature** available on the **Workspace Business** plan.
64 changes: 32 additions & 32 deletions workspaces/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,79 +3,79 @@
## Workspace Access and Permissions

- **What is the difference between Read and Write permissions?**
Read permissions allow you to view projects but not make changes. Write permissions let you contribute to projects. This distinction applies to guests in the workspace.
Read permissions allow you to view projects but not make changes. Write permissions let you contribute to projects. This distinction applies to guests in the workspace.

- **Can external collaborators access my Workspace?**
Yes, but only if you invite them.
Yes, but only if you invite them.

- **What happens if someone leaves my team?**
If a team member leaves or is removed, they lose access to all projects in the workspace immediately.
If a team member leaves or is removed, they lose access to all projects in the workspace immediately.

- **Can I have multiple Workspaces under one account?**
Yes, there is no limit on the number of Workspaces you can have.
Yes, there is no limit to the number of Workspaces you can have.

## Workspace Features and Customisation

- **Can I use Workspaces as an individual or are they only for teams?**
You can use Workspaces as an individual to organise your work. However, Workspaces are designed to shine in a team environment with tools for collaboration and project management.
- **Can I use Workspaces individually, or are they only for teams?**
You can use Workspaces as an individual to organise your work. However, Workspaces are designed to shine in a team environment with tools for collaboration and project management.

- **Can I customise the Workspace interface to suit my team’s workflow for projects in it?**
Customisation is limited to the Workspace name, description, and logo.
- **Can I customise the Workspace interface to suit my team’s project workflow?**
Customisation is limited to the Workspace name, description, and logo.

- **Can I switch between different Workspace plans?**
Switching plans is still under development and will be detailed soon.
Plan switching is not yet available but is under development and will be detailed soon.

## Data and Security

- **How does Speckle ensure data security within Workspaces?**
Projects in paid Workspaces are private by default, and all data is stored encrypted. Workspace admins manage membership, while project owners control their teams but can’t add non-members. Admins can also enforce a domain-based email policy for additional security.
Projects in paid Workspaces are private by default, and all data is stored encrypted. Workspace admins manage membership, while project owners control their teams but cannot add non-members. Admins can also enforce a domain-based email policy for additional security.

- **What happens to my data when I create a Workspace?**
Existing data remains unaffected. Any new projects created in the Workspace will benefit from its protections and policies.
Existing data remains unaffected. Any new projects created in the Workspace will benefit from its protections and policies.

- **Will my data be backed up automatically in a Workspace?**
Yes, backups are handled automatically as per our data policies.
Yes, backups are handled automatically as per our data policies.

- **What are the storage limits for Workspaces?**
There are no limits on version storage, and the file upload limit will increase to 100 TB.
There are no limits on version storage. File upload limits will increase to 100 TB.

- **Where is my data stored if I’m not using Workspaces?**
For projects outside of Workspaces, data is stored in Speckle's default regions. These are dynamically assigned based on server efficiency and latency to ensure optimal performance for the user creating the project. Specific data residency is not guaranteed outside of Workspaces.

## Subscription and Billing

- **What is the mechanism if I have 2 members at the start of the month and 5 at the end?**
You will be billed for the total number of members at the end of the month, which in this case would be 5.
You will be billed for the total number of members at the end of the month, which in this case would be 5.

- **What happens to my Workspace if I decide to cancel my subscription?**
If your version limit is exceeded, further edits will be blocked, but your data will remain intact until you reactivate your subscription.
If your version limit is exceeded, further edits will be blocked, but your data will remain intact until you reactivate your subscription.

## Upcoming Features and Support
## Features and Support

- **Can I migrate my existing Speckle projects to a Workspace?**
Not yet, but this feature is coming soon.

- **How do I request a custom feature for my Workspace?**
Contact us at <[email protected]> and we can tailor an offer depending on your needs.
Yes, this feature is now live. Migrated projects will remain in the data region in which they were authored. The ability to migrate projects to a different data region is coming soon.

- **Will I be notified of upcoming changes to Workspace features or pricing?**
Join our community forum for real-time updates, or subscribe to our newsletter to learn more.
- **How do I request a custom plan for my Workspace?**
Contact us at <[email protected]>, and we can tailor an offer depending on your needs.

- **What support options are available for Workspace users?**
(Details on specific support offerings are available on request.)
Please refer to our support offerings or contact us directly for assistance.

## Speckle for Free and Future Plans
## Speckle for Free and Paid Features

- **Is Speckle for free going away?**
No, Speckles free version is here to stay.
- **Is Speckle's free version going away?**
No, Speckle's free version is here to stay. Projects created outside of Workspaces are referred to as Personal Projects.

- **If I can have unlimited projects and versions for free, why would I pay?**
Paid Workspaces offer advanced features like permission management, data security policies, and regional controls. If you don’t need these features, the free version will continue to meet your needs.
Paid Workspaces offer advanced features like permission management, data security policies, domain-based restrictions, and regional controls. If you don’t need these features, the free version will continue to meet your needs.

## Enterprise and Self-hosting

- **Is Workspaces available to self-hosters?**
Not yet, but we’re working on making it available. A licence from Speckle will be required.

- **Is Workspaces available on enterprise servers?**
Not currently. We’re refining the experience for enterprise use.
Not currently. We’re first refining the enterprise use experience within Workspaces on our server. However, we welcome discussions with all Enterprise partners about their needs and how this offering may evolve to support them.

- **Is Workspaces available to self-hosters?**
A self-hosted server already provides full control over security and project team access. While making Workspaces available for self-hosting is not a priority, we may explore this option. A licence from Speckle would be required.

- **Is Workspaces open-source?**
No, it is licensed under a source-available licence.
No, Workspaces is licensed under a source-available licence.
Loading

0 comments on commit 044ddef

Please sign in to comment.