mirror of
https://github.com/penpot/penpot.git
synced 2025-12-11 22:14:05 +01:00
📚 New architecture in user guide
This commit is contained in:
Esther Moreno
committed by
David Barragán Merino
David Barragán Merino
parent
89763d7c5a
commit
df718c940f
14
docs/user-guide/account-teams/comments.njk
Normal file
14
docs/user-guide/account-teams/comments.njk
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Comments
|
||||
order: 4
|
||||
desc: Learn how to import and export files in Penpot, the free, open-source design tool. Discover file formats, backups, sharing, and library management.
|
||||
---
|
||||
|
||||
<h1 id="comments">Comments</h1>
|
||||
<p class="main-paragraph">Comments allow the team to have one priceless conversation getting and providing feedback right over the designs and prototypes.<p>
|
||||
|
||||
<h2 id="comment-workspace">At the workspace</h2>
|
||||
<p>At the workspace, activate the comment tool by clicking the comment icon in the navbar or pressing the <kbd>C</kbd> key. <a href="/user-guide/designing/workspace-basics/#comments">More about comments at the Workspace</a></p>
|
||||
|
||||
<h2 id="comment-viewmode">At the View mode</h2>
|
||||
<p>You can activate comments at the View mode by pressing the comments icon at the top navbar. <a href="/user-guide/prototyping-testing/testing-view-mode/#viewmode-comments">More about comments at the View mode</a>.</p>
|
||||
28
docs/user-guide/account-teams/index.njk
Normal file
28
docs/user-guide/account-teams/index.njk
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: Account & teams
|
||||
order: 8
|
||||
desc: Begin with the Penpot user guide! Get quickstarts, shortcuts, and tutorials. Learn the interface, layers, objects, styling, and more.
|
||||
---
|
||||
|
||||
<h1 id="section-1">Account & teams</h1>
|
||||
|
||||
<ul class="intro-sections">
|
||||
<li>
|
||||
<a href="/user-guide/account-teams/your-account">
|
||||
<h2>Your account →</h2>
|
||||
<p>Ways to start with Penpot</p>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/user-guide/account-teams/teams">
|
||||
<h2>Teams →</h2>
|
||||
<p>Info of interest about Penpot</p>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/user-guide/account-teams/comments/">
|
||||
<h2>Comments →</h2>
|
||||
<p>Info of interest about Penpot</p>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
69
docs/user-guide/account-teams/teams.njk
Normal file
69
docs/user-guide/account-teams/teams.njk
Normal file
@@ -0,0 +1,69 @@
|
||||
---
|
||||
title: Teams
|
||||
order: 2
|
||||
desc: Manage teams and roles with Penpot's collaboration features! Learn how to manage teams, roles (Viewer, Editor, Admin, Owner), send invites and use webhooks.
|
||||
---
|
||||
|
||||
<h1 id="teams">Teams</h1>
|
||||
<p class="main-paragraph">A team is a group of members who collaborate on a collection of projects.
|
||||
Team members are allowed to work with any project or file within the team. The actions that each team
|
||||
member is allowed to do depends on their permissions.</p>
|
||||
<p class="main-paragraph">At Penpot you can create and join as many teams as you need and add all necessary stakeholders with no team size limits.</p>
|
||||
|
||||
<h2 id="teams-management">Manage teams</h2>
|
||||
<p>At Penpot you can create as many teams as you need and be invited to teams owned by others. Learn how to manage them.</p>
|
||||
|
||||
<h3>Select team</h3>
|
||||
<p>At the top left of the dashboard you can find the team selector.</p>
|
||||
|
||||
<p>"Your Penpot" is the name of your personal space at Penpot. It is like any other team but in which no members can be invited so that you will always have your own private dashboard. Create or join other teams to collaborate with other Penpot users.</p>
|
||||
<figure><img src="/img/teams/team-selector.webp" alt="Teams selector" /></figure>
|
||||
|
||||
<h3>Create teams</h3>
|
||||
<p>To create a new team go to the bottom of the team selector and press "+ Create new team". Then you will be asked to enter a team name and that's it. Once a new team is created you are able to invite new team members.</p>
|
||||
<figure><img src="/img/teams/team-selector-projects.webp" alt="Teams selector" /></figure>
|
||||
|
||||
<h3>Delete and leave teams</h3>
|
||||
<p>All members can leave the team anytime from the same menu.</p>
|
||||
<p>Only the team owner can delete a team. The option can be found at the team menu (the three dots at the right side). When deleting a team all projects and files belonging to it will be permanently deleted.</p>
|
||||
<figure><img src="/img/teams/team-selector-delete.webp" alt="Teams selector" /></figure>
|
||||
|
||||
<h3>Team settings</h3>
|
||||
<p>At the team settings you can see the information about how many members, projects and files belong to it. Team name and profile picture can be updated.</p>
|
||||
|
||||
<h2 id="teams-members">Team members</h2>
|
||||
<p>At the team members area you can view all the users that are inside the team and manage them according to your permissions.</p>
|
||||
<figure><img src="/img/teams/team-members.webp" alt="Team members" /></figure>
|
||||
|
||||
<h3>Team roles</h3>
|
||||
<p>These are the team roles currently available at Penpot:</p>
|
||||
<ul>
|
||||
<li><strong>Viewer:</strong> Viewers can view, comment on and inspect files but will not be able to edit them, nor do they have permissions to manage team settings.</strong></li>
|
||||
<li><strong>Editor:</strong> Editors can create, import, edit and manage files and libraries, but do not have permissions to manage team settings.</strong></li>
|
||||
<li><strong>Admin:</strong> Admins have the same permissions as editors, with the added ability to change every other member's role except owners. They can invite members and update team settings.</strong></li>
|
||||
<li><strong>Owner:</strong> There's only one owner per team, the role is automatically assigned to the team creator. Owners have all the permissions of admins, with the additional ability to change any member's role, including transferring ownership. Owners can update team settings, invite members and delete teams.</strong></li>
|
||||
</ul>
|
||||
|
||||
<h3>Transfer ownership</h3>
|
||||
<p>An owner can transfer their ownership to another team member anytime and is requested to transfer it before leaving the team.</p>
|
||||
<figure><img src="/img/teams/team-transfer.webp" alt="Transfer team" /></figure>
|
||||
|
||||
<h2 id="teams-invites">Team invitations</h2>
|
||||
<h3>Invite people to a team</h3>
|
||||
<p>You can invite people to join the team using the "Invite to team" window. Add their emails separated by comma, select the role that will be assigned to them and press "Send invitation". An invitation will be sent to each of the added emails that still will need to be accepted.</p>
|
||||
<figure><img src="/img/teams/team-invite.webp" alt="Invite to team" /></figure>
|
||||
|
||||
<h2>Invitations status</h2>
|
||||
<p>Check the status of a team invitations at the "Invitations" section. Invitations can be pending (still valid but not accepted yet) or expired.</p>
|
||||
<figure><img src="/img/teams/team-invitations.webp" alt="Team invitations" /></figure>
|
||||
|
||||
<h3>Invitations options</h3>
|
||||
<p>You can perform the following actions over existing invitations:</p>
|
||||
<ul>
|
||||
<li><strong>Copy link:</strong> Will copy to your clipboard the same link that has been sent via email with the invitation, so you can have other ways to pass it to the invited person. This is specially useful for self-hosted installations, where sometimes SMTP email is not configured.</strong></li>
|
||||
<li><strong>Resend invitation:</strong> Will send the email invitation again.</strong></li>
|
||||
<li><strong>Delete invitation:</strong> Will remove the invitation from your invitation list, canceling it if is still pending.</strong></li>
|
||||
</ul>
|
||||
<figure><img src="/img/teams/team-invitations-actions.webp" alt="Team invitations actions" /></figure>
|
||||
|
||||
|
||||
74
docs/user-guide/account-teams/your-account.njk
Normal file
74
docs/user-guide/account-teams/your-account.njk
Normal file
@@ -0,0 +1,74 @@
|
||||
---
|
||||
title: Your account
|
||||
order: 1
|
||||
desc: Learn how to import and export files in Penpot, the free, open-source design tool. Discover file formats, backups, sharing, and library management.
|
||||
---
|
||||
|
||||
<h1 id="account">Your account</h1>
|
||||
<p class="main-paragraph">Your account settings can be changed at the user area, in <b>Your account</b>. Here you can make changes to your profile, password or account language, as well as generate personal access tokens and access release notes.</p>
|
||||
|
||||
<h3 id="your-account-profile">Profile
|
||||
<a class="direct-link" href="#your-account-profile">#</a>
|
||||
</h3>
|
||||
<p>If you want to change the email address associated to your account or remove your account entirely, this can be done in the <b>Profile</b> section.</p>
|
||||
<figure>
|
||||
<img src="/img/interface/youraccount-profile.webp" alt="Penpot's profile" />
|
||||
</figure>
|
||||
|
||||
<h3 id="your-account-password">Password
|
||||
<a class="direct-link" href="#your-account-password">#</a>
|
||||
</h3>
|
||||
<p>If you want to change your password to a new one, this can be done in the <b>Password</b> section.</p>
|
||||
<figure>
|
||||
<img src="/img/interface/youraccount-password.webp" alt="Penpot's password" />
|
||||
</figure>
|
||||
|
||||
<h3 id="your-account-notifications">Notifications
|
||||
<a class="direct-link" href="#your-account-notifications">#</a>
|
||||
</h3>
|
||||
<p>At the <strong>Notifications</strong> section you can configure the email and dashboard notifications.</p>
|
||||
<figure>
|
||||
<img src="/img/interface/youraccount-notifications.webp" alt="Penpot's notifications" />
|
||||
</figure>
|
||||
|
||||
<h3 id="your-account-settings">Settings
|
||||
<a class="direct-link" href="#your-account-settings">#</a>
|
||||
</h3>
|
||||
<p>At the <strong>Settings</strong> section you can change the language and the UI color theme.</p>
|
||||
<figure>
|
||||
<img src="/img/interface/youraccount-settings.webp" alt="Penpot's settings" />
|
||||
</figure>
|
||||
|
||||
<h3 id="interface-ui-theme">UI Theme</h3>
|
||||
<p>Penpot's default interface is dark but you can switch anytime to a light option. You have 2 ways to change the theme:</p>
|
||||
<ul>
|
||||
<li>From "Your account" > "Settings".</li>
|
||||
<li>Using the shortcut <kbd>Alt/⌥</kbd> + <kbd>M</kbd>.</li>
|
||||
</ul>
|
||||
|
||||
<figure>
|
||||
<a href="/img/interface/dashboard-light.webp" target="_blank">
|
||||
<img src="/img/interface/dashboard-light.webp" alt="Penpot's dashboard" />
|
||||
</a>
|
||||
<figcaption>Penpot's dashboard in light mode</figcaption>
|
||||
</figure>
|
||||
<figure>
|
||||
<a href="/img/interface/workspace-light.webp" target="_blank">
|
||||
<img src="/img/interface/workspace-light.webp" alt="Penpot's workspace" />
|
||||
</a>
|
||||
<figcaption>Penpot's workspace in light mode</figcaption>
|
||||
</figure>
|
||||
<figure>
|
||||
<a href="/img/interface/viewmode-light.webp" target="_blank">
|
||||
<img src="/img/interface/viewmode-light.webp" alt="Penpot's view mode" />
|
||||
</a>
|
||||
<figcaption>Penpot's view mode in light mode</figcaption>
|
||||
</figure>
|
||||
|
||||
|
||||
<h3 id="your-account-accesstokens">Access tokens
|
||||
<a class="direct-link" href="#your-account-accesstokens">#</a>
|
||||
</h3>
|
||||
<p>At the <strong>Asset tokens</strong> section you can manage your access tokens. <a href="https://help.penpot.app/technical-guide/integration/#access-tokens" target="_blank">Read more about access tokens here</a>.</p>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user