Skip to content

Commit f4d3bfb

Browse files
committed
Document project members
1 parent eca2912 commit f4d3bfb

5 files changed

Lines changed: 49 additions & 12 deletions

File tree

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
export default {
2-
'publishing': ''
2+
'publishing': '',
3+
'management': ''
34
};
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import {Callout} from 'nextra/components';
2+
3+
# Project management
4+
5+
The project dashboard is where you find all your project information. You can tweak project settings, deploy new
6+
versions, list registered game content and more.
7+
8+
## Deployments
9+
10+
Deployments serve as a version history for Wiki projects. Every time you make changes to your documentation in the
11+
source repository, you'll need to create a new Deployment to publish them on the website.
12+
13+
For your own convenience, we recommend automatically revalidating docs after publication using our
14+
[Gradle plugin](./devs#-gradle-plugin-companion) instead.
15+
16+
## Members
17+
18+
You can grant access to your project to other Wiki users under the "Members" tab.
19+
20+
Members can be added by their Wiki username, which can be found in the [User Settings](https://moddedmc.wiki/en/dev/settings) page.
21+
Generally, this will be the lowercase username of the GitHub account you use to sign in to the Wiki.
22+
23+
<Callout type="warning">
24+
A user must have an active Wiki account to be added to projects. If you're getting a *User not found* error when
25+
trying to add your teammates by their GitHub username, make sure they log in to the Wiki first!
26+
</Callout>
27+
28+
### Roles
29+
30+
When adding team members, you can choose between two available roles:
31+
32+
- **Owner** - has **full access** to the project. This includes deleting the project or removing other owners!
33+
- **Member** - can edit project settings and create new deployments. Cannot manage members nor delete the project.
34+
35+
### Leaving projects
36+
37+
Users with the "Member" role may leave projects on their own at any time by using the Members tab.
38+
However, owners can only leave as long as they are not the only owner.

apps/docs/content/en/docs/portal/publishing.mdx

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,4 @@ the repository. There is no need to prefix the path with a branch or tag name.
125125
When your project registration succeeds, you'll be redirected to the project management dashboard and a
126126
new deployment will be created automatically.
127127

128-
### Deployments
129-
130-
Deployments serve as a version history for Wiki projects. Every time you make changes to your documentation in the
131-
source repository, you'll need to create a new Deployment to publish them on the website.
132-
133-
For your own convenience, we recommend automatically revalidating docs after publication using our
134-
[Gradle plugin](./devs#-gradle-plugin-companion) instead.
128+
See the [Project management](management) to learn about the project dashboard panel.

apps/web/src/app/[locale]/(dashboard)/dev/(home)/settings/page.tsx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,18 @@ function UserProfileInfo({user}: { user: UserProfile }) {
3737
<img src={user.avatar_url} width={84} height={84} className="rounded-sm" alt="avatar"/>
3838
</div>
3939

40-
<div className="flex w-full flex-col justify-between gap-2">
41-
<div className="flex flex-row items-center justify-between">
42-
<span className="text-lg text-primary-alt">
43-
{user.username}
40+
<div className="flex w-full flex-col">
41+
<div className="mb-0.5 flex flex-row items-center justify-between">
42+
<span className="text-lg leading-5 text-primary-alt">
43+
{user.name}
4444
</span>
4545
{user.role === UserRole.ADMIN &&
4646
<AdminBadge />
4747
}
4848
</div>
49+
<div className="mb-auto text-sm text-secondary">
50+
{user.username}
51+
</div>
4952
<div className="flex justify-between text-sm text-secondary">
5053
<span>{t('bio')}</span>
5154
<span>{t('join_date', {date: joinDate})}</span>

packages/shared/src/types/api/auth.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ export enum UserRole {
44
}
55

66
export interface UserProfile {
7+
name: string;
78
username: string;
89
avatar_url: string;
910
modrinth_id: string | null;

0 commit comments

Comments
 (0)