mirror of https://github.com/zulip/zulip.git
help: Update help pages according to profile page redesign.
This commit fixes the documentation of settings as we have replaced "Your account" section into two new sections - "Profile" and "Account & privacy". This commit also fixes a comment in the test for settings documentation in test_middleware.py.
This commit is contained in:
parent
bb816e1998
commit
0c80d23857
|
@ -15,7 +15,7 @@ bot's API key can impersonate the bot, so be careful with it!
|
||||||
|
|
||||||
Anyone with your API key can impersonate you, so be doubly careful with it.
|
Anyone with your API key can impersonate you, so be doubly careful with it.
|
||||||
|
|
||||||
{settings_tab|your-account}
|
{settings_tab|account-and-privacy}
|
||||||
|
|
||||||
1. Under **API key**, click **Show/change your API key**.
|
1. Under **API key**, click **Show/change your API key**.
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,7 @@ Organization administrators can
|
||||||
|
|
||||||
{start_tabs}
|
{start_tabs}
|
||||||
|
|
||||||
{settings_tab|your-account}
|
{settings_tab|account-and-privacy}
|
||||||
|
|
||||||
2. Under **User settings**, click on the button with your email address.
|
2. Under **User settings**, click on the button with your email address.
|
||||||
|
|
||||||
|
|
|
@ -11,16 +11,14 @@ is useful when users' names are managed via LDAP or another data source.
|
||||||
|
|
||||||
{start_tabs}
|
{start_tabs}
|
||||||
|
|
||||||
{settings_tab|your-account}
|
{settings_tab|profile}
|
||||||
|
|
||||||
1. Under **User settings**, click on the button with your name in it.
|
1. Edit the **full name** field.
|
||||||
|
|
||||||
1. Change your name, and click **Change**.
|
|
||||||
|
|
||||||
{end_tabs}
|
{end_tabs}
|
||||||
|
|
||||||
!!! warn ""
|
!!! warn ""
|
||||||
**Note:** If you are unable to click on the button with your name, check
|
**Note:** If you are unable to edit the full name field, check
|
||||||
that your organization allows name changes. Follow the steps at
|
that your organization allows name changes. Follow the steps at
|
||||||
[prevent users from changing their names](/help/restrict-name-and-email-changes)
|
[prevent users from changing their names](/help/restrict-name-and-email-changes)
|
||||||
to view your organization's settings.
|
to view your organization's settings.
|
||||||
|
|
|
@ -24,7 +24,7 @@ account.
|
||||||
|
|
||||||
{start_tabs}
|
{start_tabs}
|
||||||
|
|
||||||
{settings_tab|your-account}
|
{settings_tab|account-and-privacy}
|
||||||
|
|
||||||
2. Under **User settings**, click on the password field (it should look like `********`).
|
2. Under **User settings**, click on the password field (it should look like `********`).
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ You can also upload a custom profile picture to Zulip.
|
||||||
|
|
||||||
{start_tabs}
|
{start_tabs}
|
||||||
|
|
||||||
{settings_tab|your-account}
|
{settings_tab|profile}
|
||||||
|
|
||||||
2. Under **Profile picture**, click **Upload new profile picture** and choose an image to upload.
|
2. Under **Profile picture**, click **Upload new profile picture** and choose an image to upload.
|
||||||
|
|
||||||
|
@ -21,7 +21,7 @@ You can also upload a custom profile picture to Zulip.
|
||||||
|
|
||||||
{start_tabs}
|
{start_tabs}
|
||||||
|
|
||||||
{settings_tab|your-account}
|
{settings_tab|profile}
|
||||||
|
|
||||||
2. Under **Profile picture**, click on the **(X)** icon in the top
|
2. Under **Profile picture**, click on the **(X)** icon in the top
|
||||||
right corner of the profile picture.
|
right corner of the profile picture.
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
{start_tabs}
|
{start_tabs}
|
||||||
|
|
||||||
{settings_tab|your-account}
|
{settings_tab|account-and-privacy}
|
||||||
|
|
||||||
1. Under **User Settings**, click **Deactivate account**.
|
1. Under **User Settings**, click **Deactivate account**.
|
||||||
|
|
||||||
|
|
|
@ -12,16 +12,12 @@ fill them out.
|
||||||
|
|
||||||
{start_tabs}
|
{start_tabs}
|
||||||
|
|
||||||
{settings_tab|your-account}
|
{settings_tab|profile}
|
||||||
|
|
||||||
1. Edit the fields under **Profile**.
|
1. Edit the fields under **Profile**.
|
||||||
|
|
||||||
{end_tabs}
|
{end_tabs}
|
||||||
|
|
||||||
!!! warn ""
|
|
||||||
Note: The **Profile** section will only appear if an organization
|
|
||||||
administrator has added custom profile fields.
|
|
||||||
|
|
||||||
## Related articles
|
## Related articles
|
||||||
|
|
||||||
* [Change your name](/help/change-your-name)
|
* [Change your name](/help/change-your-name)
|
||||||
|
|
|
@ -17,7 +17,7 @@ gear_info = {
|
||||||
# name is what the item is called in the gear menu: `Select **name**.`
|
# name is what the item is called in the gear menu: `Select **name**.`
|
||||||
# link is used for relative links: `Select [name](link).`
|
# link is used for relative links: `Select [name](link).`
|
||||||
"manage-streams": ["Manage streams", "/#streams/subscribed"],
|
"manage-streams": ["Manage streams", "/#streams/subscribed"],
|
||||||
"settings": ["Settings", "/#settings/your-account"],
|
"settings": ["Settings", "/#settings/profile"],
|
||||||
"manage-organization": ["Manage organization", "/#organization/organization-profile"],
|
"manage-organization": ["Manage organization", "/#organization/organization-profile"],
|
||||||
"integrations": ["Integrations", "/integrations"],
|
"integrations": ["Integrations", "/integrations"],
|
||||||
"stats": ["Usage statistics", "/stats"],
|
"stats": ["Usage statistics", "/stats"],
|
||||||
|
|
|
@ -16,7 +16,8 @@ link_mapping = {
|
||||||
# breadcrumb to that setting to the name of its setting type, the setting
|
# breadcrumb to that setting to the name of its setting type, the setting
|
||||||
# name as it appears in the user interface, and a relative link that can
|
# name as it appears in the user interface, and a relative link that can
|
||||||
# be used to get to that setting
|
# be used to get to that setting
|
||||||
"your-account": ["Settings", "Your account", "/#settings/your-account"],
|
"profile": ["Settings", "Profile", "/#settings/profile"],
|
||||||
|
"account-and-privacy": ["Settings", "Account & privacy", "/#settings/account-and-privacy"],
|
||||||
"display-settings": ["Settings", "Display settings", "/#settings/display-settings"],
|
"display-settings": ["Settings", "Display settings", "/#settings/display-settings"],
|
||||||
"notifications": ["Settings", "Notifications", "/#settings/notifications"],
|
"notifications": ["Settings", "Notifications", "/#settings/notifications"],
|
||||||
"your-bots": ["Settings", "Your bots", "/#settings/your-bots"],
|
"your-bots": ["Settings", "Your bots", "/#settings/your-bots"],
|
||||||
|
|
|
@ -98,7 +98,7 @@ class OpenGraphTest(ZulipTestCase):
|
||||||
)
|
)
|
||||||
|
|
||||||
def test_settings_tab(self) -> None:
|
def test_settings_tab(self) -> None:
|
||||||
# deactivate-your-account starts with {settings_tab|your-account}
|
# deactivate-your-account starts with {settings_tab|account-and-privacy}
|
||||||
self.check_title_and_description(
|
self.check_title_and_description(
|
||||||
"/help/deactivate-your-account",
|
"/help/deactivate-your-account",
|
||||||
"Deactivate your account (Zulip Help Center)",
|
"Deactivate your account (Zulip Help Center)",
|
||||||
|
|
Loading…
Reference in New Issue