Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial Docs v1.0 #1

Merged
merged 54 commits into from
Apr 16, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
d2506dc
initial-commit
y0014984 Mar 6, 2024
7e16700
2024-03-06-a
y0014984 Mar 6, 2024
7599f83
2024-03-06-b
y0014984 Mar 6, 2024
7bf7417
fixed image link
y0014984 Mar 7, 2024
34faa9b
2024-03-07-a
y0014984 Mar 7, 2024
ce9427d
2024-03-11 a
y0014984 Mar 11, 2024
3683d5b
2024-03-11 b
y0014984 Mar 11, 2024
7a1d274
2024-03-15-a
y0014984 Mar 15, 2024
50c778e
added simple search bar
y0014984 Mar 16, 2024
07b5b07
2024-03-16-a
y0014984 Mar 16, 2024
fe7e106
2024-03-16-b
y0014984 Mar 16, 2024
7636e18
2024-03-18-a
y0014984 Mar 18, 2024
434155e
2024-03-18-b
y0014984 Mar 18, 2024
06066a8
2024-03-18-c
y0014984 Mar 18, 2024
57aca6e
2024-03-19-a
y0014984 Mar 19, 2024
10e888a
added image zoom
y0014984 Mar 19, 2024
8c4d4ae
2024-03-22-a
y0014984 Mar 22, 2024
e8bba7a
moved images and videos in article related subfolders
y0014984 Mar 22, 2024
b496ac4
updated 'team' page
y0014984 Apr 1, 2024
683a1db
moved raw images and videos
y0014984 Apr 1, 2024
8c45394
added favicon
y0014984 Apr 1, 2024
4af9e1b
added robots.txt
y0014984 Apr 1, 2024
cf31ecf
moved 'ai-generated' folder
y0014984 Apr 1, 2024
121100f
reorganized some images (public folder and general)
y0014984 Apr 1, 2024
01a5d30
small fix
y0014984 Apr 1, 2024
50fe0de
modified changelog
y0014984 Apr 1, 2024
6298aa7
renamed 'explore' to 'overview'
y0014984 Apr 1, 2024
e27b797
changed discord roadmap description
y0014984 Apr 1, 2024
b5e92e3
fixed english typos
y0014984 Apr 1, 2024
0a8816d
added DE translation (WIP)
y0014984 Apr 1, 2024
bfcf5a1
added DE translation (WIP)
y0014984 Apr 2, 2024
ad662c6
added DE translation (WIP)
y0014984 Apr 2, 2024
20d92cc
added DE translation (WIP)
y0014984 Apr 2, 2024
28c5013
added DE translation
y0014984 Apr 3, 2024
9e45207
vitepress update v1.0.0 RC44 -> v1.0.2
y0014984 Apr 5, 2024
8ebd787
added lazy loading
y0014984 Apr 5, 2024
f7105a8
converted PNG to WEBP and GIF to WEBM
y0014984 Apr 5, 2024
239b6b5
added SVG exports
y0014984 Apr 5, 2024
35cad97
fixed missing image
y0014984 Apr 5, 2024
94c1f6e
added SVG crown symbol
y0014984 Apr 5, 2024
9bb6ea9
changed screenshots (WIP)
y0014984 Apr 5, 2024
5c2e370
changed screenshots (WIP)
y0014984 Apr 6, 2024
0330a7b
changed invite links format
y0014984 Apr 8, 2024
32caaae
changed description of guest event invitations
y0014984 Apr 8, 2024
0a2db93
added info about the mandatory event-community interlink
y0014984 Apr 8, 2024
a155412
removed PNG and GIF files
y0014984 Apr 8, 2024
c06b69e
changed screenshots and other stuff
y0014984 Apr 10, 2024
a2576e7
Create README.md
y0014984 Apr 10, 2024
9d22a44
Merge branch 'initial-docs' of https://github.com/arma-events/docs in…
y0014984 Apr 10, 2024
f404767
changed warning message
y0014984 Apr 11, 2024
3833c72
added overview link to index page
y0014984 Apr 11, 2024
e285bbd
changed dev dependency to vitepress 1.0.2
y0014984 Apr 11, 2024
1c06f95
fixed link
y0014984 Apr 11, 2024
1ab4b9f
fixed typo
y0014984 Apr 14, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions communities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Communities

## Create a Community

## Delete a Community

## Manage Community Settings

### Display Name vs. Unique-ID vs. Tag

Set the **display name** of your community to any string that is less or equal 50 unicode characters. The display name is the one that is displayed on **arma.events** most of the time. You can share the same display name with other communities.

The **unique-ID** is a string with 32 or less web-safe characters that has to be unique on our platform. The availability of the unique-ID is checked every time you try to change it. The unique-ID is mostly used in URLs. In all other cases the display name is shown.

The **tag** of your community is a string that is 10 or less characters long. ***TO CLARIFY: Current use of the tag is unclear. Perhaps the tag will be used as a prefix on users's display names in events mit multiple communities with format `[TAG] user display name`. I'm not sure.***

![Community Name Types](images/community-name-types.png "Community Name Types")

### Logo and Color

![Community Logo](images/community-logo.png "Community Logo")

## Invite Members

## Remove Members

## Manage Admin Rights
Binary file added images/alerts-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alerts-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alerts-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alt-code-block.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alt-headlines.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alt-text-attributes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alt-unsorted-lists.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alt2-unsorted-lists.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/autolinks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/avatar.afdesign
Binary file not shown.
Binary file added images/avatar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/blockquote.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/code-block.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/community-logo.afdesign
Binary file not shown.
Binary file added images/community-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/community-name-types.afdesign
Binary file not shown.
Binary file added images/community-name-types.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/create-account.afdesign
Binary file not shown.
Binary file added images/create-account.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/escaping.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/games-and-dlcs.afdesign
Binary file not shown.
Binary file added images/games-and-dlcs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/headlines.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/horizontal-rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/images.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/links.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/markdown-examples.afdesign
Binary file not shown.
Binary file added images/markdown-vs-no-markdown.afdesign
Binary file not shown.
Binary file added images/markdown-vs-no-markdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/mouse.afdesign
Binary file not shown.
Binary file added images/name-vs-username.afdesign
Binary file not shown.
Binary file added images/name-vs-username.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/paragraphs-and-line-breaks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/sessions.afdesign
Binary file not shown.
Binary file added images/sessions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/sorted-lists.png
Binary file added images/text-attributes.png
Binary file added images/unsorted-lists.png
Binary file not shown.
Binary file added images/user-profile-communities-overview.png
Binary file added images/user-profile.afdesign
Binary file not shown.
Binary file added images/user-profile.png
105 changes: 105 additions & 0 deletions markdown.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
# Markdown

Markdown is a plain text lightweight markup language for creating formatted text and structured documents. **arma.events** supports Markdown for structuring your event texts. Using Markdown is completely optional. You can simply write your texts and structure them by creating separate text boxes with headlines and without using Markdown at all. If you intend to use Markdown see the list of the supported text markups below.

![Markdown vs. No Markdown](images/markdown-vs-no-markdown.png "Markdown vs. No Markdown")

## Paragraphs and Line Breaks

Each return in your text will create a line manual break. Each blank line will create a new paragraph.

![Paragraphs and Line Breaks](images/paragraphs-and-line-breaks.png "Paragraphs and Line Breaks")

## Heading

With the #-based syntax you can create up to 4 headline hierarchies. With `=====` and `-----` you can create only 2 hierarchies.

![Headlines](images/headlines.png "Headlines")

![Headlines - Alternative Syntax](images/alt-headlines.png "Headlines - Alternative Syntax")

## Text Attributes

\**italic*\* or \__italic_\_ (Alternative Syntax)

\*\***bold**\*\* or \_\___bold__\_\_ (Alternative Syntax)

\*\*\****bold italic***\*\*\* or \_\_\____bold italic___\_\_\_ (Alternative Syntax)

\``monospaced`\`

\~\~~~strikethrough~~\~\~

![Text Attributes](images/text-attributes.png "Text Attributes")

![Text Attributes - Alternative Syntax](images/alt-text-attributes.png "Text Attributes - Alternative Syntax")

## Horizontal Rule

With three dashes `---` you can create a horizontal line. Keep a blank line before and after to prevent formatting issues.

![Horizontal Rule](images/horizontal-rule.png "Horizontal Rule")

## Unsorted Lists

Add two blank spaces in front of your list item for intendation. You can use `-`,`+` or `*` as list sign.

![Unsorted Lists](images/unsorted-lists.png "Unsorted Lists")

![Unsorted Lists - Alternative Syntax 1](images/alt-unsorted-lists.png "Unsorted Lists - Alternative Syntax 1")

![Unsorted Lists - Alternative Syntax 2](images/alt2-unsorted-lists.png "Unsorted Lists - Alternative Syntax 2")

## Sorted Lists

Add two blank spaces in front of your list item for intendation.

![Sorted Lists](images/sorted-lists.png "Sorted Lists")

## Links

Format `[LINKED TEXT] (URL "MOUSEOVER TEXT")`

![Links](images/links.png "Links")

## Images

Format `![ALTERNATIVE TEXT] (URL "MOUSEOVER TEXT")`

![Images](images/images.png "Images")

## Autolinks and Email Addresses

Enclose your URL or email address in `<` and `>` to create an automatic link with the URI as the link text.

![Autolinks](images/autolinks.png "Autolinks")

## Code Block (monospaced text)

Beginn every line with ` ` 4 blank spaces to create a code block. Alternatively, enclose the text in ` ``` ` to create a code block. No support for syntax highlighting.

![Code Block](images/code-block.png "Code Block")

![Code Block Alternative](images/alt-code-block.png "Code Block Alternative")

## Blockquote

Beginn every line with `>` and a ` ` blank space to create a blockquote.

![Blockquote](images/blockquote.png "Blockquote")

## Alerts

Markdown alerts are created like blockquotes but the first line contains a keyword like `[!NOTE]` or `[!WARNING]`.

![Alerts 1](images/alerts-1.png "Alerts 1")

![Alerts 2](images/alerts-2.png "Alerts 2")

![Alerts 3](images/alerts-3.png "Alerts 3")

## Escaping Markdown characters

If you want to treat Markdown characters as normal text then you can escape these characters with the `\` prefix.

![Escaping](images/escaping.png "Escaping")
Binary file added raw screenshots/Screenshot 2024-03-05 094353.png
Binary file added raw screenshots/Screenshot 2024-03-05 094705.png
Binary file added raw screenshots/Screenshot 2024-03-05 101520.png
Binary file added raw screenshots/Screenshot 2024-03-05 102357.png
Binary file added raw screenshots/Screenshot 2024-03-05 103028.png
Binary file added raw screenshots/Screenshot 2024-03-05 103038.png
Binary file added raw screenshots/Screenshot 2024-03-05 103447.png
Binary file added raw screenshots/Screenshot 2024-03-05 103456.png
Binary file added raw screenshots/Screenshot 2024-03-05 104457.png
Binary file added raw screenshots/Screenshot 2024-03-05 105451.png
Binary file added raw screenshots/Screenshot 2024-03-05 105506.png
Binary file added raw screenshots/Screenshot 2024-03-05 141622.png
Binary file added raw screenshots/Screenshot 2024-03-05 141632.png
Binary file added raw screenshots/Screenshot 2024-03-05 142015.png
Binary file added raw screenshots/Screenshot 2024-03-05 142025.png
Binary file added raw screenshots/Screenshot 2024-03-05 143425.png
Binary file added raw screenshots/Screenshot 2024-03-05 143438.png
Binary file added raw screenshots/Screenshot 2024-03-05 144142.png
Binary file added raw screenshots/Screenshot 2024-03-05 144152.png
Binary file added raw screenshots/Screenshot 2024-03-05 145202.png
Binary file added raw screenshots/Screenshot 2024-03-05 145209.png
Binary file added raw screenshots/Screenshot 2024-03-05 145835.png
Binary file added raw screenshots/Screenshot 2024-03-05 145841.png
Binary file added raw screenshots/Screenshot 2024-03-05 150110.png
Binary file added raw screenshots/Screenshot 2024-03-05 150117.png
Binary file added raw screenshots/Screenshot 2024-03-05 150916.png
Binary file added raw screenshots/Screenshot 2024-03-05 151719.png
Binary file added raw screenshots/Screenshot 2024-03-05 151726.png
Binary file added raw screenshots/Screenshot 2024-03-05 152529.png
Binary file added raw screenshots/Screenshot 2024-03-05 152535.png
Binary file added raw screenshots/Screenshot 2024-03-05 153231.png
Binary file added raw screenshots/Screenshot 2024-03-05 154617.png
Binary file added raw screenshots/Screenshot 2024-03-05 154624.png
Binary file added raw screenshots/Screenshot 2024-03-05 155251.png
Binary file added raw screenshots/Screenshot 2024-03-05 155303.png
Binary file added raw screenshots/Screenshot 2024-03-05 155546.png
Binary file added raw screenshots/Screenshot 2024-03-05 155555.png
Binary file added raw screenshots/Screenshot 2024-03-05 155816.png
Binary file added raw screenshots/Screenshot 2024-03-05 155823.png
Binary file added raw screenshots/Screenshot 2024-03-05 160020.png
Binary file added raw screenshots/Screenshot 2024-03-05 160025.png
Binary file added raw screenshots/Screenshot 2024-03-05 160748.png
Binary file added raw screenshots/Screenshot 2024-03-05 163647.png
Binary file added raw screenshots/Screenshot 2024-03-05 175513.png
Binary file added raw screenshots/Screenshot 2024-03-05 180626.png
Binary file added raw screenshots/Screenshot 2024-03-05 181237.png
Binary file added raw screenshots/Screenshot 2024-03-05 184524.png
Binary file added raw screenshots/Screenshot 2024-03-05 184534.png
Binary file added raw screenshots/Screenshot 2024-03-05 184547.png
Binary file added raw screenshots/Screenshot 2024-03-06 163749.png
Binary file added raw screenshots/Screenshot 2024-03-06 163851.png
Binary file added raw screenshots/Screenshot 2024-03-06 163933.png
Binary file added raw screenshots/Screenshot 2024-03-06 163942.png
Binary file added raw screenshots/Screenshot 2024-03-06 164032.png
Binary file added raw screenshots/Screenshot 2024-03-06 164046.png
Binary file added raw screenshots/Screenshot 2024-03-06 164103.png
Binary file added raw screenshots/Screenshot 2024-03-06 164323.png
Binary file added raw screenshots/Screenshot 2024-03-06 193405.png
Binary file added raw screenshots/Screenshot 2024-03-06 195059.png
Binary file added raw screenshots/Screenshot 2024-03-06 195106.png
Binary file added raw screenshots/Screenshot 2024-03-06 195117.png
7 changes: 7 additions & 0 deletions table-of-contents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Table of contents

- [User](user.md "User")
- [Communities](communities.md "Communities")
- [Events](events.md "Events")
- [Markdown](markdown.md "Markdown")
- [Support](support.md "Support")
59 changes: 59 additions & 0 deletions user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# User

## Login with Steam SSO

It is very likely that every player that wants to use our platform has a Steam account. That is why we decided to link accounts on **arma.events** to the players Steam account. You simply need to login with your Steam account. That's all it takes. There is currently no way to create an account based on email address and password. Steam takes care of the login process for us. We can neither see your passord nor access your steam account.

## Create User Account

It takes only three simple assistant-driven steps to create an **arma.events** user account. First, login with your existing Steam Account. You will be redirected automatically to Steam and back whithin this process. Second, confirm or change your display name. Third, choose your avatar or leave it blank.

![Create Account](images/create-account.png "Create Account")

That's it. You are now succcessfully logged into arma.events with your Steam account. You can change everything later in your profile settings. Now you can create your own community or ask your community manager to send you an invite to your community. As a member of a community you can join the events of that community. See [Communities](communities.md "Communities") for more information.

![User Profile](images/user-profile.png "User Profile")

## Delete User Account

***WIP***

## Edit User Profile

### Avatar

Various image file formats are supported. You can zoom into your image with the **scroll wheel** of your mouse and move the image while holding your **left mouse button**. The avatar is always displayed in a circle. We store your image with a resolution of 256x256 pixels. Using a very low-res image or zooming in can lead to a blurry image.

![Avatar](images/avatar.png "Avatar")

### Display Name vs. Handle

The **display name** and the **handle** are identical after first login. But they can be changed later individually.

Set your **display name** to any string that is less or equal 50 unicode characters. The display name is the one that is displayed on **arma.events** most of the time. You can share the same display name with other users.

The **handle** is a string with 32 or less web-safe characters that has to be unique on our platform. The availability of the handle is checked every time you try to change it. The handle is mostly used in URLs. In all other cases the display name is shown.

![Name vs. Username](images/name-vs-username.png "Name vs. Username")

### Communities

Your user profile contains a list of all communities you are a member of. You can use this overview to quickly jump to the community or the leave the communities you no longer want to be part of by using the 3 dots context menu.

Keep in mind that the community will be deleted if you are the only/last member. If there are other members but you are the only administrator of this community then you need to transfer your admin rights to another member. See [communities](communities.md "Communities") for more information about community management.

![Sessions](images/user-profile-communities-overview.png "Sessions")

### Sessions

Session management is a security feature. It lists every active browser session on your devices. Feel free to close/revoke all sessions you no longer need or all sessions at once. A revoked session means that you need to login again on that specific device/browser combination.

![Sessions](images/games-and-dlcs.png "Sessions")
y0014984 marked this conversation as resolved.
Show resolved Hide resolved

### Games and DLCs

In your profile you can setup which games you own. Currently supported are Arma 3 and Arma Reforger. Contact our [Support](support.md "Support") if you are interested in adding more games. If the game supports DLCs then please specify which DLCs you own.

Your owned DLCs will be matched against the DLC requirements that a mission creator has defined for a specific event. In case of a missing DLC you will get a warning.

![Games and DLCs](images/games-and-dlcs.png "Games and DLCs")