mirror of
https://github.com/LemmyNet/lemmy-docs.git
synced 2024-11-01 10:09:54 +00:00
Docs update (#101)
* Update guide.md * Moved What is this? to about * added What is this? from guide * Update guide.md - removed landlord comparison - spell check - added direct link to the !privacy@lemmy.ml community * Correction of typos * Add files via upload * corrections as requested by dessalines * corrections as requested by dessalines * Create moderation * Delete moderation * added moderation guide * added more button moderation capture * fixed the table, had an extra column * line break correction * table correction * added appoint as admin * removed IFramely removed IFramely as new version will no longer use it * clarifications
This commit is contained in:
parent
9974390a68
commit
16155e31d6
6 changed files with 88 additions and 26 deletions
|
@ -6,9 +6,13 @@ Front Page|Post
|
||||||
|
|
||||||
[Lemmy](https://github.com/LemmyNet/lemmy) is similar to sites like [Reddit](https://reddit.com), [Lobste.rs](https://lobste.rs), [Raddle](https://raddle.me), or [Hacker News](https://news.ycombinator.com/): you subscribe to forums you're interested in, post links and discussions, then vote, and comment on them. Behind the scenes, it is very different; anyone can easily run a server, and all these servers are federated (think email), and connected to the same universe, called the [Fediverse](https://en.wikipedia.org/wiki/Fediverse).
|
[Lemmy](https://github.com/LemmyNet/lemmy) is similar to sites like [Reddit](https://reddit.com), [Lobste.rs](https://lobste.rs), [Raddle](https://raddle.me), or [Hacker News](https://news.ycombinator.com/): you subscribe to forums you're interested in, post links and discussions, then vote, and comment on them. Behind the scenes, it is very different; anyone can easily run a server, and all these servers are federated (think email), and connected to the same universe, called the [Fediverse](https://en.wikipedia.org/wiki/Fediverse).
|
||||||
|
|
||||||
For a link aggregator, this means a user registered on one server can subscribe to forums on any other server, and can have discussions with users registered elsewhere.
|
*The word “fediverse” (federated universe) refers to the network of all Lemmy servers [and other projects](https://blog.joinmastodon.org/2018/06/why-activitypub-is-the-future/), users of which are able to talk to each other seamlessly.*
|
||||||
|
|
||||||
The overall goal is to create an easily self-hostable, decentralized alternative to reddit and other link aggregators, outside of their corporate control and meddling.
|
Like email, whether you sign up on GMail or Outlook, you know you’ll be able to email everyone you need to, as long as you know their address. On Lemmy you're able to subscribe to communities on any other server, and can have discussions with users registered elsewhere.
|
||||||
|
|
||||||
|
The overall goal is to create an easily self-hostable, decentralized alternative to reddit and other link aggregators, without a single company running the show.
|
||||||
|
|
||||||
|
There are no shareholders, and no targeted advertising: only people sharing the things they want to share with each other.
|
||||||
|
|
||||||
Each lemmy server can set its own moderation policy; appointing site-wide admins, and community moderators to keep out the trolls, and foster a healthy, non-toxic environment where all can feel comfortable contributing.
|
Each lemmy server can set its own moderation policy; appointing site-wide admins, and community moderators to keep out the trolls, and foster a healthy, non-toxic environment where all can feel comfortable contributing.
|
||||||
|
|
||||||
|
|
|
@ -1,39 +1,78 @@
|
||||||
# Lemmy Guide
|
# Lemmy Quick Start Guide
|
||||||
|
|
||||||
Start typing...
|
So you want to join Lemmy and get posting. Great! Here's how to dive straight in.
|
||||||
|
|
||||||
|
## Where do I sign up?
|
||||||
|
|
||||||
|
The first thing you have to do is **choose your server**. This is an extra step compared to sites like Reddit, but isn’t as difficult as it may seem.
|
||||||
|
|
||||||
|
*Like with email, your identity is hosted by the server you sign up on. So for example, I joined lemmy.ml so to mention me you can type @retiolus@lemmy.ml in your post.*
|
||||||
|
|
||||||
|
If what you want to talk about most fits into a clear category (maybe it’s video games or art or queer life or coding or fiction, etc) then it might be worth making your first server one where that will primarily host that sort of content – it’ll be easier to make connections and find like-minded folk. Think of your server as a neighbourhood or a venue, where the general chatter can have a specific focus.
|
||||||
|
|
||||||
|
*You have the ability to view all public local posts that have been made by people on your server in the “Local” tab.*
|
||||||
|
|
||||||
|
If you aren’t here to stick mainly to one topic, you’ll likely want to pick a server that caters to general interests. Either way, there’s a helpful servers list on [join-lemmy.org](https://join-lemmy.org/instances).
|
||||||
|
|
||||||
|
**Don’t panic!** You’ll be able to chatter to people on other servers, no matter which one you choose. Remember, this is like email, and you can still email your mum on her ancient Yahoo account from your GMail, for example.
|
||||||
|
|
||||||
|
## Knowing your server
|
||||||
|
|
||||||
|
Take a moment before registering to check out the rules of your chosen server and make sure they are compatible with how you want to be posting.
|
||||||
|
|
||||||
|
Servers usually define their rules in a simple way on the sidebar on the right of the site. From top to bottom, you will usually find the list of "Trending communities" followed by "Subscribed to communities", a brief description of the server, the rules, some stats and the username of the administrators.
|
||||||
|
|
||||||
|
Admins are super friendly people who are usually running the server out of their own pocket, so it’s good to get to know them. Many accept donations to cover the running costs and if you’re able to contribute then it’s always appreciated.
|
||||||
|
|
||||||
|
## I think I found my new home!
|
||||||
|
|
||||||
|
Head to the Login page `(https://your.server/login)` of your server and choose your username and password in the sign up form. You don't need an email to register, but this is the only way to reset your password if you lose it.
|
||||||
|
|
||||||
|
Next thing to do is upload your profile picture, give the settings page `(https://your.server/settings)` a good once-over (and do come back to it when you’ve been on Lemmy a week or so just to make any tweaks that might help your experience) and get ready to introduce yourself.
|
||||||
|
|
||||||
|
*Some interesting settings worth checking are: your default feed sorting filter between subscribed, local or all and your default sorting type.*
|
||||||
|
|
||||||
|
While you can simply enjoy reading Lemmy, the real fun begins as you dive in and start participating yourself by posting, voting and commenting.
|
||||||
|
|
||||||
|
To share a post, click the “Create Post” button on the top side of the screen. You’ll be taken to a form where you can enter a URL of the link or upload your image, and input a title and body for the post. You will also need to enter the community where you’d like your post to appear. Before doing so, it’s a good idea to head to that communitie’s page and read the posting guidelines that appear on the right side of the screen. This will ensure you are abiding by the particular ethos of the community. For example, on the [`!privacy@lemmy.ml`](https://lemmy.ml/c/privacy) community, you are not allowed to promote proprietary software.
|
||||||
|
|
||||||
|
When all the fields are filled out, click “Create” and your post will go live.
|
||||||
|
|
||||||
|
By writing a new post or comment, start typing...
|
||||||
|
|
||||||
- `@a_user_name` to get a list of usernames.
|
- `@a_user_name` to get a list of usernames.
|
||||||
- `!a_community` to get a list of communities.
|
- `!a_community` to get a list of communities.
|
||||||
- `:emoji` to get a list of emojis.
|
- `:emoji` to get a list of emojis.
|
||||||
|
|
||||||
## Sorting
|
## A quick tour of the web interface
|
||||||
|
|
||||||
*Applies to both posts and comments*
|
![interface.png](interface.png)
|
||||||
|
|
||||||
Type | Description
|
The standard Lemmy interface has a single feed. You can change the content of the feed by using the filters:
|
||||||
--- | ---
|
|
||||||
Active | Trending sort based on the score, and the most recent comment time.
|
|
||||||
Hot | Trending sort based on the score, and the post creation time.
|
|
||||||
New | Newest items.
|
|
||||||
Most Comments | The posts with the most comments.
|
|
||||||
New Comments | The posts with most recent comments, IE a forum-style sort.
|
|
||||||
Top | The highest scoring items in the given time frame.
|
|
||||||
|
|
||||||
For more detail, check the [Post and Comment Ranking details](ranking.md).
|
**Subscribed** includes the posts of people on your server and on other servers, all that matters is that it’s community you follow.
|
||||||
|
|
||||||
## Moderation / Administration
|
**Local** is the feed of all the posts of communities on your server. On many servers, particularly smaller ones and ones focused on a particular topic, this is where the magic happens. You can reply to people from there, and it’s a great place to meet people who share the same interests as you.
|
||||||
|
|
||||||
All moderator and admin actions on users are done on comments or posts, by clicking the `More` 3-dot icon.
|
**All**, or the **federated timeline**, is a view of all the public posts your servers knows about from across the whole network (including local ones). The most common reason that something appears in the federated timeline is that someone from your server might follow a community that's on another server.
|
||||||
|
|
||||||
This includes:
|
| Type | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| Posts | Only displays publications |
|
||||||
|
| Comments | Displays only comments |
|
||||||
|
| \-\-\- | \-\-\- |
|
||||||
|
| Active | Trending sort based on the score, and the most recent comment time. |
|
||||||
|
| Hot | Trending sort based on the score, and the post creation time. |
|
||||||
|
| New | The newest items. |
|
||||||
|
| Most Comments | The posts with the most comments. |
|
||||||
|
| New Comments | The posts with most recent comments, IE a forum-style sort. |
|
||||||
|
| Top | The highest scoring items in the given time frame. |
|
||||||
|
|
||||||
- Adding / Removing mods or admins.
|
For more detail, check the [Post and Comment Ranking details](https://join-lemmy.org/docs/en/about/ranking.html).
|
||||||
- Removing / Restoring comments.
|
|
||||||
- Banning / Unbanning users.
|
|
||||||
|
|
||||||
All admin actions on communties are done on the community sidebar. This currently only includes Removing / Restoring communities.
|
## Using Markdown
|
||||||
|
|
||||||
## Markdown Guide
|
Lemmy's posts are done using Markdown, there are of course shortcuts for you to use when writing but here is a table to help you if you want to go further.
|
||||||
|
|
||||||
Type | Or | … to Get
|
Type | Or | … to Get
|
||||||
--- | --- | ---
|
--- | --- | ---
|
||||||
|
@ -54,4 +93,3 @@ Some ~subscript~ text | | Some <sub>subscript</sub> text
|
||||||
Some ^superscript^ text | | Some <sup>superscript</sup> text
|
Some ^superscript^ text | | Some <sup>superscript</sup> text
|
||||||
|
|
||||||
[CommonMark Tutorial](https://commonmark.org/help/tutorial/)
|
[CommonMark Tutorial](https://commonmark.org/help/tutorial/)
|
||||||
|
|
||||||
|
|
BIN
src/en/about/interface.png
Normal file
BIN
src/en/about/interface.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 150 KiB |
|
@ -13,12 +13,11 @@ to AWS using their [Cloud Development Kit](https://docs.aws.amazon.com/cdk/lates
|
||||||
* Lemmy-UI
|
* Lemmy-UI
|
||||||
* Lemmy
|
* Lemmy
|
||||||
* Pictrs
|
* Pictrs
|
||||||
* IFramely
|
|
||||||
* CloudFront CDN
|
* CloudFront CDN
|
||||||
* EFS storage for image uploads
|
* EFS storage for image uploads
|
||||||
* Aurora Serverless Postgres DB
|
* Aurora Serverless Postgres DB
|
||||||
* Bastion VPC host
|
* Bastion VPC host
|
||||||
* Load balancers for Lemmy and IFramely
|
* Load balancers for Lemmy
|
||||||
* DNS records for your site
|
* DNS records for your site
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
21
src/en/moderation/moderation.md
Normal file
21
src/en/moderation/moderation.md
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
# Moderation actions
|
||||||
|
|
||||||
|
On Lemmy a **moderator** is someone who manages and has rights over a community.
|
||||||
|
|
||||||
|
An **administrator** has full rights on the entire server, and thus also in each community.
|
||||||
|
|
||||||
|
| Action | Result | Permission level |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| lock | Prevents making new comments under the post | Moderator |
|
||||||
|
| sticky | Pin the publication to the top of the community listing | Moderator |
|
||||||
|
| remove | Delete the post | Moderator |
|
||||||
|
| ban | Ban user from the community | Moderator |
|
||||||
|
| appoint as mod | Gives the user moderator status | Moderator |
|
||||||
|
| appoint as admin | Gives the user administrator status | Admin |
|
||||||
|
| ban from site | Ban user from the server | Admin |
|
||||||
|
|
||||||
|
To take a moderation action on a user, you need a post from that user and click on the 3 dots at the bottom right of the title.
|
||||||
|
|
||||||
|
To undo an action previously taken on a user, the same process must be followed. As an example, if a post is locked, click on the lock icon again to unlock it.
|
||||||
|
|
||||||
|
![more_button.png](more_button.png)
|
BIN
src/en/moderation/more_button.png
Normal file
BIN
src/en/moderation/more_button.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 7.4 KiB |
Loading…
Reference in a new issue