Skip to content

Commit

Permalink
starts to be clean enough for general publication
Browse files Browse the repository at this point in the history
  • Loading branch information
philippejadin committed Aug 7, 2024
1 parent fc9c4e4 commit 9bad35c
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 8 deletions.
8 changes: 2 additions & 6 deletions docs/en/first_steps.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# First steps after installation

## Discover your installation
Open your browser and go to the url of your web server. If using php's built-in web server it will be <http://localhost:8000>.

## Register the first account
Register a first user account : it will be you, and you will be super admin, yeah! Note that you need to have email sending working in order to validate your account.
If you just installed Agorakit on a server, take some time to configure it correctly for your use case.

## Introduction text on the homepage
Set an intro text on the homepage for newcomers : go to the admin page from your user profile dropdown.
Using the editor you can add external images and whatever you want.

## Check all the admin settings
Go to the admin menu (from your user profile dropdown) and check all the settings there.
Go to the admin menu (from your user profile dropdown) and check all the settings there. Pay attention to the various permissions and group types you allow on your server.
4 changes: 3 additions & 1 deletion docs/en/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,6 @@ This one shows you some interesting stats about your groups and some nice graphs
Invite people to one or more groups using the invite feature of each group. You can also add people directly if the already registered on your install. This is particularly useful if people have a hard time to confirm their email address and membership (trust me it happens).

## Memberships
TODO
On this page, you can view and export the list of members of your group. You can also check if everyone has accepted an invitation to join a group.

NOTE: The "Last activity" field shows the last time someone **wrote** something not the last time someone connected to the system. It might be misleading.
12 changes: 12 additions & 0 deletions docs/en/sign_up.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
To use Agorakit, simply connect to the Agorakit server you are using.

This can be either the shared instance at https://app.agorakit.org ("name your price" instance available for your tests and for collectives), or a server you have installed or someone manages for you.

## Registering a new user
On most servers, you can freely create a new user account. If you cannot create an account on a particular server it means registration has been disabled. In this case you need an invitation from the server admin to join the server.

## The special case of the first user account
If you register a user account on a new server (one without any existing user), you will be the server admin (super user) on this server.


NOTE: You need to have email sending working in order to validate your account.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ nav:
- 'Using Agorakit':
- Signing up: sign_up.md
- First steps after install : first_steps.md
- Using Agorakit : usage.md
- Creating & managing a group : group.md
- Using Agorakit : usage.md
- 'Running Agorakit':
- Installation : install.md
- Advanced configurations : advanced_config.md
Expand Down

0 comments on commit 9bad35c

Please sign in to comment.