summaryrefslogtreecommitdiff
path: root/docs/user_guide
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user_guide')
-rw-r--r--docs/user_guide/settings.md (renamed from docs/user_guide/user_panel.md)45
1 files changed, 27 insertions, 18 deletions
diff --git a/docs/user_guide/user_panel.md b/docs/user_guide/settings.md
index fc5c54835..9cc7c076c 100644
--- a/docs/user_guide/user_panel.md
+++ b/docs/user_guide/settings.md
@@ -1,16 +1,16 @@
-# User Settings Panel
+# Settings
-GoToSocial provides a settings panel where you can update your post settings, add an avatar and header image, write a bio for your account, and so on.
+GoToSocial provides a settings interface where you can update your post settings, add an avatar and header image, write a bio for your account, and so on.
-You can access the User Settings Panel at `/user` on your instance. If your instance is at `https://www.example.org`, then your User Settings Panel will be at `https://www.example.org/user`.
+You can access the Settings at `https://my-instance.example.com/settings` with your own GoToSocial instance. It uses the same OAUTH mechanism as normal clients (with scope: admin), and as such can be accessed from anywhere, separately from your own instance, or ran locally. A public installation is available here: [https://gts.superseriousbusiness.org/settings](https://gts.superseriousbusiness.org).
-You will be prompted to log in to the User Settings Panel with your email address and password.
+You will be prompted to log in with your email address and password after providing the instance url (auto-filled when using the page that comes with your instance).
-## Profile Info
+## Profile
-![Screenshot of the Profile Info section of the User Settings Panel](../assets/user-settings-profile-info.png)
+![Screenshot of the profile section of the user settings interface, showing a preview of the avatar, header and display name, and providing form fields to change them](../assets/user-settings-profile-info.png)
-In the first section of the User Settings Panel, you can upload header and avatar images for your profile, update your display name and bio, and toggle whether or not to manually approve new follow requests.
+In the profile section you can change your display name, avatar and header images. You can also choose to enable manually approving follow requests, and opt-in to providing a public RSS feed of your posts.
### Set Avatar / Header
@@ -18,9 +18,9 @@ To set an avatar or header image, click on the `Browse` button in the appropriat
Currently, supported image formats are `gif`, `png`, and `jpeg`/`jpg`.
-A preview of the image as it will appear on your profile will be shown. If you're happy with your choices, click on the `Save profile info` button at the bottom of the Profile Info section. If you navigate to your profile in the web browser and refresh the page, your new avatar / header will be shown.
+A preview of the image as it will appear on your profile will be shown. If you're happy with your choices, click on the `Save profile info` button at the bottom of the Profile Info section. If you navigate to your profile and refresh the page, your new avatar / header will be shown. It might take a bit longer for the update to federate out to remote instances.
-### Set Display Name and Bio
+### Set Displayname and Bio
Your display name is a short handle shown alongside your username on your profile. While your username cannot be changed once it's created, your display name can. Your display name can also contain spaces, capital letters, emojis, and so on. It's a great place to put a nickname, full name, and/or pronouns. For example, if your username is `@miranda`, your display name could be something like `Miranda Priestly (she/her)`.
@@ -32,11 +32,11 @@ Your bio is a longer text that introduces your account and your self. Your bio i
- Describe your boundaries and preferences when it comes to other people interacting with you
- Link hashtags that you often use when you post
-The bio accepts either `plain` or `markdown` formatting. This is set by the default post format setting described in [Post Settings](#post-settings).
+The bio accepts either `plain` or `markdown` formatting. This is set by the default post format setting described in [User Settings](#user-settings).
After updating your display name and bio, click on the `Save profile info` button at the bottom of the Profile Info section to save your changes.
-### Manually Approve Followers / Lock Your Account
+### Manually Approve Followe Requests / Lock Your Account
At the bottom of the Profile Info section, there's a checkbox to manually approve follow requests.
@@ -48,15 +48,22 @@ This option is often referred to on the fediverse as "locking" your account.
After ticking or unticking the checkbox, be sure to click on the `Save profile info` button at the bottom to save your new settings.
-## Post Settings
+### Enable RSS feed of Public posts
-![Screenshot of the Post Settings section of the User Settings Panel](../assets/user-settings-post-settings.png)
+RSS (Really Simple Syndication) is a protocol for web feeds separate from ActivityPub, where users can aggregrate various feeds from different sites like blogs and podcasts. It's important to note that this by-passes follow requests, allowing anyone to get updates on your public posts. This feed only includes posts set as 'Public' (see [Privacy Settings](./posts.md#privacy-settings)).
-In the Post Settings section of the User Settings Panel, you can set various defaults for new posts.
+### Custom CSS
+If enabled on your instance, [Custom CSS](./custom_css.md) allows you to theme the way your profile looks when visited through a browser. When this setting is not enabled, the field is hidden.
+
+## Settings
+
+![Screenshot of the user settings section, providing drop-down menu's to select default post settings, and form fields to change your password](../assets/user-settings-post-settings.png)
+
+In the 'Settings' section, you can set various defaults for new posts.
The default post language setting allows you to indicate to other fediverse users which language your posts are usually written in. This is helpful for fediverse users who speak (for example) Korean, and would prefer to filter out posts written in other languages.
-The default post privacy setting allows you to set the default privacy for new posts. This is useful when you generally prefer to post public or followers-only, but you don't want to have to remember to set the privacy every time you post. Remember, this is only the default: no matter what you set here, you can still set the privacy individually for new posts if desired. For more information on post privacy settings, see the [posts page](./posts.md).
+The default post privacy setting allows you to set the default privacy for new posts. This is useful when you generally prefer to post public or followers-only, but you don't want to have to remember to set the privacy every time you post. Remember, this is only the default: no matter what you set here, you can still set the privacy individually for new posts if desired. For more information on post privacy settings, see the [page on Posts](./posts.md).
The default post format setting allows you to set which text interpreter should be used when parsing your posts.
@@ -68,8 +75,10 @@ When you are finished updating your post settings, remember to click the `Save p
## Password Change
-![Screenshot of the Password Change section of the User Settings Panel](../assets/user-settings-password-change.png)
-
You can use the Password Change section of the User Settings Panel to set a new password for your account.
-For more information on GoToSocial password managing, please see the [password management document](./password_management.md).
+For more information on the way GoToSocial manages passwords, please see the [Password management document](./password_management.md).
+
+## Admins
+
+If your account has been promoted to admin, this interface will also show sections related to admin actions, see [Admin Settings](../admin/settings.md). \ No newline at end of file