mirror of
https://github.com/zulip/zulip.git
synced 2025-10-23 04:52:12 +00:00
help: Do not treat Help Center
as a proper noun.
Fixes https://chat.zulip.org/#narrow/channel/101-design/topic/help.20center.20capitalization
This commit is contained in:
committed by
Tim Abbott
parent
421637ce31
commit
468a7a82dd
@@ -370,7 +370,7 @@ it? There's several major benefits to this system:
|
|||||||
version, with the key variables (like the Zulip server URL) already
|
version, with the key variables (like the Zulip server URL) already
|
||||||
pre-substituted for the user.
|
pre-substituted for the user.
|
||||||
- We're able to share implementation language and visual styling with
|
- We're able to share implementation language and visual styling with
|
||||||
our Help Center, which is especially useful for the extensive
|
our help center, which is especially useful for the extensive
|
||||||
non-REST API documentation pages (e.g., our bot framework).
|
non-REST API documentation pages (e.g., our bot framework).
|
||||||
|
|
||||||
Using the standard OpenAPI format gives us flexibility, though; if we
|
Using the standard OpenAPI format gives us flexibility, though; if we
|
||||||
|
@@ -53,8 +53,8 @@ means that one person might be a user of multiple Zulip realms. The
|
|||||||
administrators of an organization have a great deal of control over
|
administrators of an organization have a great deal of control over
|
||||||
who can register an account, what permissions new users have, etc. For
|
who can register an account, what permissions new users have, etc. For
|
||||||
more on security considerations and options, see [the security model
|
more on security considerations and options, see [the security model
|
||||||
section](../production/security-model.md) and the [Zulip Help
|
section](../production/security-model.md) and the [Zulip help
|
||||||
Center](https://zulip.com/help/).
|
center](https://zulip.com/help/).
|
||||||
|
|
||||||
## Components
|
## Components
|
||||||
|
|
||||||
|
@@ -67,7 +67,7 @@ _Released 2025-09-11_
|
|||||||
- Fixed a bug resulting in useless extra suggestions in the search
|
- Fixed a bug resulting in useless extra suggestions in the search
|
||||||
typeahead.
|
typeahead.
|
||||||
- Optimized performance for processing deleted messages slightly.
|
- Optimized performance for processing deleted messages slightly.
|
||||||
- Backported several improvements to Help Center and API
|
- Backported several improvements to help center and API
|
||||||
documentation.
|
documentation.
|
||||||
- Added configuration options to allow webhooks to access to specific
|
- Added configuration options to allow webhooks to access to specific
|
||||||
local-network IP addresses.
|
local-network IP addresses.
|
||||||
@@ -1056,7 +1056,7 @@ _Released 2024-07-25_
|
|||||||
- Improved how desktop and mobile push notifications display quoted
|
- Improved how desktop and mobile push notifications display quoted
|
||||||
content to focus on the reply over the quoted content.
|
content to focus on the reply over the quoted content.
|
||||||
- Improved filtering options for the GitHub integration.
|
- Improved filtering options for the GitHub integration.
|
||||||
- Improved dozens of Help Center articles.
|
- Improved dozens of help center articles.
|
||||||
- Improved wording in various automated notices.
|
- Improved wording in various automated notices.
|
||||||
- Improved new-organization defaults for various permissions settings.
|
- Improved new-organization defaults for various permissions settings.
|
||||||
- Improved how users are displayed in settings to use clickable user
|
- Improved how users are displayed in settings to use clickable user
|
||||||
@@ -1734,7 +1734,7 @@ _Released 2023-05-31_
|
|||||||
- New compose box features: Scheduling a message to be sent later, a
|
- New compose box features: Scheduling a message to be sent later, a
|
||||||
nicer stream picker, and the ability to switch between stream and
|
nicer stream picker, and the ability to switch between stream and
|
||||||
private messages.
|
private messages.
|
||||||
- Numerous improvements to the Help Center, including documentation
|
- Numerous improvements to the help center, including documentation
|
||||||
for how to complete many common tasks in the Zulip mobile apps.
|
for how to complete many common tasks in the Zulip mobile apps.
|
||||||
- Redesigned the interface and permissions model for moving topics to
|
- Redesigned the interface and permissions model for moving topics to
|
||||||
be independent from message content editing, providing a cleaner
|
be independent from message content editing, providing a cleaner
|
||||||
@@ -2469,8 +2469,8 @@ _Released 2022-03-29_
|
|||||||
- Redesigned hover behavior for timestamps and time mentions.
|
- Redesigned hover behavior for timestamps and time mentions.
|
||||||
- Messages sent by muted users can now be rehidden after being
|
- Messages sent by muted users can now be rehidden after being
|
||||||
revealed. One can also now mute deactivated users.
|
revealed. One can also now mute deactivated users.
|
||||||
- Rewrote Help Center guides for new organizations and users, and made
|
- Rewrote help center guides for new organizations and users, and made
|
||||||
hundreds of other improvements to Help Center content and organization.
|
hundreds of other improvements to help center content and organization.
|
||||||
- Reimplemented the image lightbox's pan/zoom functionality to be
|
- Reimplemented the image lightbox's pan/zoom functionality to be
|
||||||
nicer, allowing us to enable it be default.
|
nicer, allowing us to enable it be default.
|
||||||
- Added styled loading page for the web application.
|
- Added styled loading page for the web application.
|
||||||
@@ -3649,7 +3649,7 @@ _Released 2019-12-12_
|
|||||||
bot's owner.
|
bot's owner.
|
||||||
- Restructured "private messages" widget to have a cleaner design.
|
- Restructured "private messages" widget to have a cleaner design.
|
||||||
- Significantly improved performance of the backend Markdown processor.
|
- Significantly improved performance of the backend Markdown processor.
|
||||||
- Significantly improved Help Center documentation of dozens of features.
|
- Significantly improved help center documentation of dozens of features.
|
||||||
- Simplified and internationalized some notification bot messages.
|
- Simplified and internationalized some notification bot messages.
|
||||||
- The compose box placeholder now shows users active status.
|
- The compose box placeholder now shows users active status.
|
||||||
- Clicking the "EDITED" text on a message now pops message edit history.
|
- Clicking the "EDITED" text on a message now pops message edit history.
|
||||||
@@ -3903,7 +3903,7 @@ _Released 2019-03-01_
|
|||||||
- Expanded production documentation for more unusual deployment options.
|
- Expanded production documentation for more unusual deployment options.
|
||||||
- Expanded set of characters allowed in custom linkifiers.
|
- Expanded set of characters allowed in custom linkifiers.
|
||||||
- Optimized development provisioning; now takes 2s in the no-op case.
|
- Optimized development provisioning; now takes 2s in the no-op case.
|
||||||
- Zulip's Help Center now has nicely generated open graph tags.
|
- Zulip's help center now has nicely generated open graph tags.
|
||||||
- Fixed missing API authentication headers for mobile file access.
|
- Fixed missing API authentication headers for mobile file access.
|
||||||
- Fixed various select and copy-paste issues.
|
- Fixed various select and copy-paste issues.
|
||||||
- Fixed various back button bugs in settings UI.
|
- Fixed various back button bugs in settings UI.
|
||||||
@@ -4058,7 +4058,7 @@ _Released 2018-11-07_
|
|||||||
- Updated numerous pages within the /help/ site.
|
- Updated numerous pages within the /help/ site.
|
||||||
- We no longer require re-authing to sign up after trying to log in with
|
- We no longer require re-authing to sign up after trying to log in with
|
||||||
an OAuth authentication backend (GitHub or Google).
|
an OAuth authentication backend (GitHub or Google).
|
||||||
- Made major improvements to the Help Center.
|
- Made major improvements to the help center.
|
||||||
- Improved system for configuring the S3 file uploads backend.
|
- Improved system for configuring the S3 file uploads backend.
|
||||||
- Improved emoji typeahead sorting.
|
- Improved emoji typeahead sorting.
|
||||||
- Improved Zulip's layout for windows with a width around 1024px.
|
- Improved Zulip's layout for windows with a width around 1024px.
|
||||||
|
@@ -103,7 +103,7 @@ Use commas in whole sentences where it is required. You can use these instructio
|
|||||||
- Filter - **Suodata**
|
- Filter - **Suodata**
|
||||||
- Full member - **Täysivaltainen jäsen**
|
- Full member - **Täysivaltainen jäsen**
|
||||||
- Host - **Isäntä**
|
- Host - **Isäntä**
|
||||||
- Help Center - **Tukikeskus**
|
- Help center - **Tukikeskus**
|
||||||
- ID - **Tunnus**
|
- ID - **Tunnus**
|
||||||
- Integraatio - **Integraatio**
|
- Integraatio - **Integraatio**
|
||||||
- Interactive - **Interaktiivinen**
|
- Interactive - **Interaktiivinen**
|
||||||
|
@@ -68,7 +68,7 @@ organization in Zulip). The following files are involved in the process:
|
|||||||
|
|
||||||
- `zerver/openapi/zulip.yaml`: OpenAPI definitions for the Zulip REST API.
|
- `zerver/openapi/zulip.yaml`: OpenAPI definitions for the Zulip REST API.
|
||||||
- `api_docs/changelog.md`: documentation listing all changes to the Zulip Server API.
|
- `api_docs/changelog.md`: documentation listing all changes to the Zulip Server API.
|
||||||
- `help/...`: end user facing documentation (Help Center) for the application.
|
- `help/...`: end user facing documentation (help center) for the application.
|
||||||
|
|
||||||
### Adding a field to the database
|
### Adding a field to the database
|
||||||
|
|
||||||
|
@@ -137,7 +137,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2>Development instructions for Help Center (Beta)</h2>
|
<h2>Development instructions for help center (Beta)</h2>
|
||||||
<p>
|
<p>
|
||||||
These commands are to run the project for an ongoing migration for our help center docs to use
|
These commands are to run the project for an ongoing migration for our help center docs to use
|
||||||
<a href="https://github.com/withastro/starlight">@astrojs/starlight</a>. You can track the
|
<a href="https://github.com/withastro/starlight">@astrojs/starlight</a>. You can track the
|
||||||
|
@@ -22,7 +22,6 @@ IGNORED_PHRASES = [
|
|||||||
r"GCM",
|
r"GCM",
|
||||||
r"GitHub",
|
r"GitHub",
|
||||||
r"Gravatar",
|
r"Gravatar",
|
||||||
r"Help Center",
|
|
||||||
r"HTTP",
|
r"HTTP",
|
||||||
r"ID",
|
r"ID",
|
||||||
r"IDs",
|
r"IDs",
|
||||||
|
@@ -680,7 +680,7 @@ html_rules: list["Rule"] = [
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"pattern": r"link=\"help/",
|
"pattern": r"link=\"help/",
|
||||||
"description": "Relative links to Help Center should start with /help/",
|
"description": "Relative links to help center should start with /help/",
|
||||||
"good_lines": ['link="/help/foo"'],
|
"good_lines": ['link="/help/foo"'],
|
||||||
"bad_lines": ['link="help/foo"'],
|
"bad_lines": ['link="help/foo"'],
|
||||||
},
|
},
|
||||||
|
@@ -31,7 +31,7 @@ function register_tabbed_section($tabbed_section: JQuery): void {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Display the copy-to-clipboard button inside the .codehilite element
|
// Display the copy-to-clipboard button inside the .codehilite element
|
||||||
// within the API and Help Center docs using clipboard.js
|
// within the API and help center docs using clipboard.js
|
||||||
function add_copy_to_clipboard_element($codehilite: JQuery): void {
|
function add_copy_to_clipboard_element($codehilite: JQuery): void {
|
||||||
const $copy_button = $("<span>").addClass("copy-button copy-codeblock");
|
const $copy_button = $("<span>").addClass("copy-button copy-codeblock");
|
||||||
$copy_button.html(zulip_copy_icon());
|
$copy_button.html(zulip_copy_icon());
|
||||||
|
@@ -263,7 +263,7 @@ times, and more.
|
|||||||
Here are a few messages I understand: {bot_commands}
|
Here are a few messages I understand: {bot_commands}
|
||||||
|
|
||||||
Check out our [Getting started guide](/help/getting-started-with-zulip),
|
Check out our [Getting started guide](/help/getting-started-with-zulip),
|
||||||
or browse the [Help center](/help/) to learn more!
|
or browse the [help center](/help/) to learn more!
|
||||||
""").format(bot_commands=bot_commands(no_help_command=True))
|
""").format(bot_commands=bot_commands(no_help_command=True))
|
||||||
else:
|
else:
|
||||||
return _("""
|
return _("""
|
||||||
|
@@ -8579,7 +8579,7 @@ paths:
|
|||||||
Fetch the message edit history of a previously edited message.
|
Fetch the message edit history of a previously edited message.
|
||||||
|
|
||||||
Note that edit history may be disabled in some organizations; see the
|
Note that edit history may be disabled in some organizations; see the
|
||||||
[Zulip Help Center documentation on editing messages][edit-settings].
|
[Zulip help center documentation on editing messages][edit-settings].
|
||||||
|
|
||||||
[edit-settings]: /help/view-a-messages-edit-history
|
[edit-settings]: /help/view-a-messages-edit-history
|
||||||
parameters:
|
parameters:
|
||||||
@@ -10079,7 +10079,7 @@ paths:
|
|||||||
|
|
||||||
This API corresponds to the
|
This API corresponds to the
|
||||||
[delete a message completely][delete-completely] feature documented in
|
[delete a message completely][delete-completely] feature documented in
|
||||||
the Zulip Help Center.
|
the Zulip help center.
|
||||||
|
|
||||||
[delete-completely]: /help/delete-a-message#delete-a-message-completely
|
[delete-completely]: /help/delete-a-message#delete-a-message-completely
|
||||||
x-requires-administrator: true
|
x-requires-administrator: true
|
||||||
|
@@ -100,7 +100,7 @@ class OpenGraphTest(ZulipTestCase):
|
|||||||
def test_nonexistent_page(self) -> None:
|
def test_nonexistent_page(self) -> None:
|
||||||
self.check_title_and_description(
|
self.check_title_and_description(
|
||||||
"/api/not-a-real-page",
|
"/api/not-a-real-page",
|
||||||
# Probably we should make this "Zulip Help Center"
|
# Probably we should make this "Zulip help center"
|
||||||
"No such article. | Zulip API documentation",
|
"No such article. | Zulip API documentation",
|
||||||
[
|
[
|
||||||
"No such article.",
|
"No such article.",
|
||||||
|
@@ -142,7 +142,7 @@ class TutorialTests(ZulipTestCase):
|
|||||||
"`apps`, `profile`, `theme`, "
|
"`apps`, `profile`, `theme`, "
|
||||||
"`channels`, `topics`, `message formatting`, `keyboard shortcuts`.\n\n"
|
"`channels`, `topics`, `message formatting`, `keyboard shortcuts`.\n\n"
|
||||||
"Check out our [Getting started guide](/help/getting-started-with-zulip), "
|
"Check out our [Getting started guide](/help/getting-started-with-zulip), "
|
||||||
"or browse the [Help center](/help/) to learn more!"
|
"or browse the [help center](/help/) to learn more!"
|
||||||
)
|
)
|
||||||
self.assertEqual(most_recent_message(user).content, expected_response)
|
self.assertEqual(most_recent_message(user).content, expected_response)
|
||||||
|
|
||||||
@@ -161,7 +161,7 @@ class TutorialTests(ZulipTestCase):
|
|||||||
"`apps`, `profile`, `theme`, "
|
"`apps`, `profile`, `theme`, "
|
||||||
"`channels`, `topics`, `message formatting`, `keyboard shortcuts`.\n\n"
|
"`channels`, `topics`, `message formatting`, `keyboard shortcuts`.\n\n"
|
||||||
"Check out our [Getting started guide](/help/getting-started-with-zulip), "
|
"Check out our [Getting started guide](/help/getting-started-with-zulip), "
|
||||||
"or browse the [Help center](/help/) to learn more!"
|
"or browse the [help center](/help/) to learn more!"
|
||||||
)
|
)
|
||||||
message = most_recent_message(user)
|
message = most_recent_message(user)
|
||||||
self.assertEqual(message.content, expected_response)
|
self.assertEqual(message.content, expected_response)
|
||||||
|
Reference in New Issue
Block a user