From d2791d47a59800b6a7c93ccd347d1f883c10fa2e Mon Sep 17 00:00:00 2001 From: Aleksandr Prokudin Date: Thu, 6 Feb 2025 14:20:10 +0100 Subject: [PATCH] Cleanup, more links, less gifs --- docs/account-team/account-settings/index.md | 8 ++--- docs/account-team/index.md | 7 +++- .../organizations/create-new/index.md | 22 ++---------- .../organizations/delete-org/index.md | 2 +- docs/account-team/organizations/index.md | 10 +++--- .../manage-admin-access/index.md | 26 +++++--------- .../organizations/manage-users/index.md | 34 +++---------------- .../workspaces/create-new/index.md | 12 ++----- docs/account-team/workspaces/delete/index.md | 1 + docs/account-team/workspaces/index.md | 9 ++++- docs/account-team/workspaces/manage/index.md | 1 + .../account-team/workspaces/settings/index.md | 1 + docs/account-team/workspaces/types/index.md | 1 + docs/index.md | 14 ++++++-- docs/key-concepts/index.md | 5 +-- docs/upload-share/embed-code/index.md | 10 +----- docs/upload-share/index.md | 7 ++-- .../pin-protected-share-links/index.md | 16 --------- docs/upload-share/public-share-links/index.md | 14 -------- docs/upload-share/upload/index.md | 10 ------ 20 files changed, 63 insertions(+), 147 deletions(-) diff --git a/docs/account-team/account-settings/index.md b/docs/account-team/account-settings/index.md index 00402cb3..a081b675 100644 --- a/docs/account-team/account-settings/index.md +++ b/docs/account-team/account-settings/index.md @@ -13,17 +13,13 @@ There are two ways to access account settings: 1. Click on the **3 dot icon** located at the bottom of the sidebar. Then, select **Account Settings**. -![Snapshot](go-to-settings-1.gif) - --- 2. Alternatively, navigate to the top of the sidebar, click on the organization name, then click on the **gear** icon of your personal organization. -![Snapshot](go-to-settings-2.gif) - --- -All account settings are divided into three parts. +All account settings are divided into five parts. ## Public Details @@ -62,4 +58,4 @@ For each organization, you can set email notifications: whether Lens should send This settings page lists all the share links, users, organization, and workspaces that you recommended, along with a complent comment for each (where available). -For more information about promoted items, please see the **Promotions** page. \ No newline at end of file +For more information about promoted items, please see the [Promotions](/docs/promotions-bookmarks/promotions/) page. \ No newline at end of file diff --git a/docs/account-team/index.md b/docs/account-team/index.md index f8f1ac39..1aba89c7 100644 --- a/docs/account-team/index.md +++ b/docs/account-team/index.md @@ -9,4 +9,9 @@ tags: sidebar_position: 5 --- -This section explain how to create new organizations, add team members, create and manage workspaces. \ No newline at end of file +This section explain how to create new organizations, add team members, create and manage workspaces. + +- [Account hierarchy](hierarchy) +- [Account settings](account-settings) +- [Managing organizations](organizations) +- [Managing workspaces](workspaces) \ No newline at end of file diff --git a/docs/account-team/organizations/create-new/index.md b/docs/account-team/organizations/create-new/index.md index ea3bf55a..0d9bd398 100644 --- a/docs/account-team/organizations/create-new/index.md +++ b/docs/account-team/organizations/create-new/index.md @@ -1,5 +1,5 @@ --- -id: create-new-org +id: org-create-new title: Creating a New Organization description: How to create a new organization in Ondsel Lens tags: @@ -13,52 +13,34 @@ This guide will explain creating a new open or private organization on Ondsel Le 1. To start creating a new organization, click on the three dots icon at the bottom of the sidebar where your account name is. -![Snapshot](step-01.gif) - --- 2. Click on **Account Settings**. -![Snapshot](step-02.gif) - --- 3. On the **Account Settings** page, switch to the **Organization Memberships** tab. -![Snapshot](step-03.gif) - --- 4. Click the **Create Organization** button. -![Snapshot](step-04.gif) - --- 5. Select the **Type of Organization**, open or private. -![Snapshot](step-05.gif) - --- 6. Type the **Name** of the organization. -![Snapshot](step-06.gif) - --- 7. Then, type the organization's **Slug**, a variation of its name used in its URL on Lens. -![Snapshot](step-07.gif) - --- 8. Now click on **Create** to finalize creating a new organization. -![Snapshot](step-08.gif) - --- -This will create a new organization and open its settings for editing. - -![Settings of a newly created organization](new-org-settings.png) \ No newline at end of file +This will create a new organization and open its settings for editing. \ No newline at end of file diff --git a/docs/account-team/organizations/delete-org/index.md b/docs/account-team/organizations/delete-org/index.md index 6cda240e..13aeb91e 100644 --- a/docs/account-team/organizations/delete-org/index.md +++ b/docs/account-team/organizations/delete-org/index.md @@ -1,5 +1,5 @@ --- -id: delete-org +id: org-delete title: Deleting Organizations description: How to delete organizations in Ondsel Lens tags: diff --git a/docs/account-team/organizations/index.md b/docs/account-team/organizations/index.md index e668c299..b253e01a 100644 --- a/docs/account-team/organizations/index.md +++ b/docs/account-team/organizations/index.md @@ -5,11 +5,13 @@ description: FIXME tags: - account sidebar_position: 3 +draft: true --- This section explains how to manage organizations on Ondsel Lens: -- What types of organizations are available -- How to create a new organization and set it up -- How to manage users in the organization -- How to delete an organization \ No newline at end of file +- [What types of organizations are available](types) +- [How to create a new organization](create-new) +- [How to manage users in the organization](manage-users) +- [How to manage admin access to the organization](manage-admin-access) +- [How to delete an organization](delete-org) \ No newline at end of file diff --git a/docs/account-team/organizations/manage-admin-access/index.md b/docs/account-team/organizations/manage-admin-access/index.md index 8b9ebdda..8bc79acf 100644 --- a/docs/account-team/organizations/manage-admin-access/index.md +++ b/docs/account-team/organizations/manage-admin-access/index.md @@ -1,5 +1,5 @@ --- -id: manage-admin-access +id: org-manage-admin-access title: Managing Admin Access description: How to manage admin access in your organization in Ondsel Lens tags: @@ -12,42 +12,32 @@ sidebar_position: 5 1. To promote a user to an administrator, navigate to the **Organization Settings** page. -Then, switch to the **Users** tab and locate the user you wish to promote. +--- -![Snapshot](promote-01.gif) +2. Switch to the **Users** tab and locate the user you wish to promote. --- -2. Click the **Edit** icon located to the right of the user's name. - -![Snapshot](promote-02.gif) +3. Click the **Edit** icon located to the right of the user's name. --- -3. After that, click the **Make Admin** button. - -![Snapshot](promote-03.gif) +4. After that, click the **Make Admin** button. -The user's status will update immediately. + The user's status will update immediately. ## Revoking admin priveleges 1. To revoke admin access, navigate to the **Organization Settings** page. -Then, switch to the **Users** tab and locate the user whose admin priveleges you want to revoke. - -![Snapshot](promote-01.gif) + Then, switch to the **Users** tab and locate the user whose admin priveleges you want to revoke. --- 2. Click the **Edit** icon located to the right of the user's name. -![Snapshot](promote-02.gif) - --- 3. Then, click the **Revoke Admin Access** button. -![Snapshot](revoke-03.gif) - -The user's status will update immediately. \ No newline at end of file + The user's status will update immediately. \ No newline at end of file diff --git a/docs/account-team/organizations/manage-users/index.md b/docs/account-team/organizations/manage-users/index.md index d11abfa2..29b419a8 100644 --- a/docs/account-team/organizations/manage-users/index.md +++ b/docs/account-team/organizations/manage-users/index.md @@ -1,5 +1,5 @@ --- -id: manage-users +id: org-manage-users title: Managing Users description: How to invite users to your organization in Ondsel Lens tags: @@ -10,30 +10,20 @@ sidebar_position: 4 ## Inviting users to organizations -1. To start inviting users to an organization, click on the three dots icon at the bottom of the sidebar where your account name is. - -Then click on **Account Settings**. - -![Snapshot](add-01.gif) +1. To start inviting users to an organization, click on the three dots icon at the bottom of the sidebar where your account name is. Then click on **Account Settings**. --- 2. On the **Account Settings** page, switch to the **Users** tab. -![Snapshot](add-02.gif) - --- 4. Click the **Invite New User** button. -![Snapshot](add-03.gif) - --- 5. Submit user's email and click **Send**. -![Snapshot](add-04.gif) - --- Once the users accepts the invitation, they will show up in the list of users and will automatically be added to all existing groups in the organization with minimum priveleges. @@ -44,44 +34,30 @@ Once the users accepts the invitation, they will show up in the list of users an 1. To start removing users from an organization, first, navigate to the **Group** tab. -![Snapshot](remove-01.gif) - --- 2. Next, remove the user from every group they are associated with. To accomplish this, go to a specific group and click on **Add / Remove User**. -![Snapshot](remove-02.gif) - --- 3. Locate the user's name and uncheck the box to the left of it. -![Snapshot](remove-03.gif) - --- -4. Then, click on **Update**. The user will no longer be part of that group. - -Repeat this process for every other group the user is a member of. +4. Then, click on **Update**. The user will no longer be part of that group. -![Snapshot](remove-04.gif) + Repeat this process for every other group the user is a member of. --- 5. Now that the user is no longer a member of any organization groups, go to the **Users** tab and find the user. -![Snapshot](remove-05.gif) - --- 6. Click on the **Edit** icon, followed by the **Remove from Organization** button. -![Snapshot](remove-06.gif) - --- 7. Finally, confirm your decision to complete the removal process. -The user will be immediately removed from the organization. - -![Snapshot](remove-07.gif) \ No newline at end of file + The user will be immediately removed from the organization. \ No newline at end of file diff --git a/docs/account-team/workspaces/create-new/index.md b/docs/account-team/workspaces/create-new/index.md index b56aeb4e..4ff29788 100644 --- a/docs/account-team/workspaces/create-new/index.md +++ b/docs/account-team/workspaces/create-new/index.md @@ -1,33 +1,25 @@ --- title: Creating a New Workspace +id: workspaces-create-new description: How to create a new workspace on Ondsel Lens sidebar_position: 2 --- -1. To create a new workspace, make sure that you are in the right organization and then click **Workspaces** in the sidebar. - -![Snapshot](create-ws-01.gif) +1. To create a new workspace, make sure that you are in the right organization and then click **Workspaces** in the left sidebar. --- 2. Click on the **Create Workspace** button. -![Snapshot](create-ws-02.gif) - --- 3. Fill in the name of the workspace, the user-visible description, and the slug. -![Snapshot](create-ws-03.jpg) - --- 4. Click **Create** to finalize the creation of the new workspace. -![Snapshot](create-ws-04.gif) - --- 5. Once the new workspace has been created, you can click the gear icon on its card to configure the workspace's settings. -![Snapshot](create-ws-05.gif) \ No newline at end of file diff --git a/docs/account-team/workspaces/delete/index.md b/docs/account-team/workspaces/delete/index.md index 390d58f6..3eeada4a 100644 --- a/docs/account-team/workspaces/delete/index.md +++ b/docs/account-team/workspaces/delete/index.md @@ -1,5 +1,6 @@ --- title: Deleting Workspaces +id: workspaces-delete description: How to delete a workspaces on Ondsel Lens sidebar_position: 5 --- diff --git a/docs/account-team/workspaces/index.md b/docs/account-team/workspaces/index.md index 3eebeca5..9203960c 100644 --- a/docs/account-team/workspaces/index.md +++ b/docs/account-team/workspaces/index.md @@ -1,9 +1,16 @@ --- title: Workspaces +id: workspaces description: How to use workspaces in Ondsel Lens tags: - workspaces sidebar_position: 4 --- -This section explains how to create, manage, and delete workspaces in an organization. \ No newline at end of file +This section explains how to create, manage, and delete workspaces in an organization. + +- [Types of Workspaces](workspaces-types) +- [How to create a new workspace](workspaces-create-new) +- [How to configure a workspace](workspaces-settings) +- [How to manage a workspaces: files and directories](workspaces-files-and-directories) +- [How to delete a workspaces](workspaces-delete) \ No newline at end of file diff --git a/docs/account-team/workspaces/manage/index.md b/docs/account-team/workspaces/manage/index.md index de559bb4..af3277e2 100644 --- a/docs/account-team/workspaces/manage/index.md +++ b/docs/account-team/workspaces/manage/index.md @@ -1,5 +1,6 @@ --- title: Files and Directories +id: workspaces-files-and-directories description: How to manage workspaces on Ondsel Lens sidebar_position: 4 --- diff --git a/docs/account-team/workspaces/settings/index.md b/docs/account-team/workspaces/settings/index.md index a1d35fe9..6e9baa81 100644 --- a/docs/account-team/workspaces/settings/index.md +++ b/docs/account-team/workspaces/settings/index.md @@ -1,5 +1,6 @@ --- title: Workspace Settings +id: workspaces-settings description: How to manage workspaces on Ondsel Lens sidebar_position: 3 --- diff --git a/docs/account-team/workspaces/types/index.md b/docs/account-team/workspaces/types/index.md index 46b72fa5..db8ae0a2 100644 --- a/docs/account-team/workspaces/types/index.md +++ b/docs/account-team/workspaces/types/index.md @@ -1,5 +1,6 @@ --- title: Types of Workspaces +id: workspaces-types description: What workspace types are available in Ondsel Lens sidebar_position: 1 --- diff --git a/docs/index.md b/docs/index.md index cb8c255f..206c1608 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,5 @@ --- -title: Overview +title: Welcome description: What is Ondsel Lens? sidebar_position: 1 --- @@ -8,7 +8,7 @@ Ondsel Lens is an online vaulting and product data management service for mechan Ondsel Lens -With Ondsel Lens you can: +## Features * Organize a team working on a product: create multiple workspaces per organization, invite and assign members * Manage the privacy of your designs @@ -20,6 +20,14 @@ With Ondsel Lens you can: * Control whether people accessing your share link can download the design * Create and organize bookmarks for other people’s work -Additionally, Lens supports uploading and downloading OBJ and STL files. +## Let's get started + +- [Upload a file](/docs/upload-share/upload/) +- [Explore it on Lens](/docs/explore/) +- [Create a PIN-protected share link](/docs/upload-share/pin-protected-share-links/) +- [Create a new workspace in your organization](/docs/account-team/workspaces/create-new/) +- [Invite team members](/docs/account-team/organizations/manage-users/) + +## Project Background Lens is built around [FreeCAD](https://www.freecad.org/), a free and open-source 3D CAD suite. It runs a containerized version of FreeCAD and uses some of the advanced features of the program. \ No newline at end of file diff --git a/docs/key-concepts/index.md b/docs/key-concepts/index.md index 1649fc5f..98d20284 100644 --- a/docs/key-concepts/index.md +++ b/docs/key-concepts/index.md @@ -9,5 +9,6 @@ sidebar_position: 2 This chapter will guide you through various key concepts of Ondsel Lens: -- Files vs models -- Share links \ No newline at end of file +- [Files vs models](/docs/key-concepts/files-vs-models/) +- [Share links](/docs/key-concepts/share-links/) +- [Slugs](/docs/key-concepts/slugs/) \ No newline at end of file diff --git a/docs/upload-share/embed-code/index.md b/docs/upload-share/embed-code/index.md index 3e24afd5..b9c06ba7 100644 --- a/docs/upload-share/embed-code/index.md +++ b/docs/upload-share/embed-code/index.md @@ -10,30 +10,22 @@ sidebar_position: 4 This tutorial will guide you through the process of obtaining the embed code for a share link of a model. -1. To begin, open the model page and click on **Explore**. - -![Snapshot](step-01.gif) +1. To begin, open the model page and click on **Explore** in the top toolbar. --- 2. In the right toolbar, click on **Manage Share Links**. -![Snapshot](step-02.gif) - --- 3. Then click the **Share** button. -![Snapshot](step-03.gif) - --- 4. Next, click **Copy to Clipboard**. This action will copy the embed code to your clipboard. -![Snapshot](step-04.gif) - --- 5. Finally, you can paste that code into your webpage. diff --git a/docs/upload-share/index.md b/docs/upload-share/index.md index a88c0edd..a09d701b 100644 --- a/docs/upload-share/index.md +++ b/docs/upload-share/index.md @@ -11,6 +11,7 @@ sidebar_position: 3 This chapter will guide you through uploading and sharing your 3D CAD models on Ondsel Lens. -- How to upload a model -- How to share a model publicly -- How to share a model privately \ No newline at end of file +- [How to upload a model](/docs/upload-share/upload/) +- [How to share a model publicly](/docs/upload-share/public-share-links/) +- [How to share a model with PIN protection](/docs/upload-share/pin-protected-share-links/) +- [How to get embed code for a model](/docs/upload-share/embed-code/) \ No newline at end of file diff --git a/docs/upload-share/pin-protected-share-links/index.md b/docs/upload-share/pin-protected-share-links/index.md index c957fe3e..cf042cf1 100644 --- a/docs/upload-share/pin-protected-share-links/index.md +++ b/docs/upload-share/pin-protected-share-links/index.md @@ -15,20 +15,14 @@ This tutorial will guide you through the process of creating a PIN-protected sha 2. Select a version and click on **Share Links**. -![Step 2](step-02.gif) - --- 3. Next, click on **Create Link**. -![Step 3](step-03.gif) - --- 4. Set a **Title** for the link. -![Step 4](step-04.gif) - --- 5. Write a **private note** that is just for yourself. @@ -37,32 +31,22 @@ This tutorial will guide you through the process of creating a PIN-protected sha 6. Change the protection method to **PIN** and then set the PIN. -![Step 6](step-06.gif) - --- 7. Select the **Version Change Handling method** as necessary. -![Step 7](step-07.gif) - --- 8. If you want the recipient to have the ability to download the original file, be sure to check the **Original File** box. -![Step 8](step-08.gif) - --- 9. Once you have completed the settings, click on **Generate Link**. -![Step 9](step-09.gif) - --- 10. Finally, right-click on external link icon and choose **Copy Link Address** to copy your protected share link. -![Step 10](step-10.gif) - --- By following these steps, you will successfully create a PIN-protected share link. \ No newline at end of file diff --git a/docs/upload-share/public-share-links/index.md b/docs/upload-share/public-share-links/index.md index 62d84278..4047f183 100644 --- a/docs/upload-share/public-share-links/index.md +++ b/docs/upload-share/public-share-links/index.md @@ -15,8 +15,6 @@ This tutorial will guide you through the process of creating a public share link 2. Next, click the **ShareLinks** button, followed by **Create link**. -![](step-02.gif) - --- 3. Set a suitable **Title** for the share link. @@ -25,26 +23,18 @@ This tutorial will guide you through the process of creating a public share link 4. You also need to set a **Private note** that is just for your own reference. -![](step-04.gif) - --- 5. Change the **Protection mode** to _Listed_. -![](step-05.gif) - --- 6. Adjust the **Version change setting** to always show the file version that is active. -![](step-06.gif) - --- 7. If you want to make the file downloadable, go to **View Export and Download Permissions**. -![](step-07.gif) - --- 8. Then check the **Original file** box. @@ -53,14 +43,10 @@ This tutorial will guide you through the process of creating a public share link 9. Finally, click on **Generate link** to produce your public share link. -![](step-09.gif) - --- 10. You can now right-click and copy the link address for your public share link. -![](step-10.gif) - --- By following these steps, you will successfully create a public share link for your model revision. diff --git a/docs/upload-share/upload/index.md b/docs/upload-share/upload/index.md index ea815271..2f4173bb 100644 --- a/docs/upload-share/upload/index.md +++ b/docs/upload-share/upload/index.md @@ -16,20 +16,14 @@ This tutorial will guide you through the process of uploading a file to your wor 2. Then, select the desired workspace. -![Snapshot](step-02.gif) - --- 3. Next, click on the **+** icon and select **Add New File**. -![Snapshot](step-03.gif) - --- 4. Click on **Browse** to choose the file you wish to upload. -![Snapshot](step-04.gif) - --- 5. The selected file will then be added to the workspace and the designated folder. @@ -38,14 +32,10 @@ This tutorial will guide you through the process of uploading a file to your wor 6. You can double-click the file to open the model page. -![Snapshot](step-06.gif) - --- 7. To preview the uploaded model view, click on **Explore**. -![Snapshot](step-07.gif) - --- By following these steps, you will successfully upload a file to your workspace and explore its content. \ No newline at end of file