mirror of
https://github.com/zulip/zulip.git
synced 2025-10-23 04:52:12 +00:00
help: Remove current help center.
This commit removes the current help center markdown files and any logic that was used to host those files at help/. We also remove a bunch of tests, we should the equivalent of those tests for the new help center. Issues to track: #35649, #35647. These issues track adding back tests for redirects and broken links. We had a symlink from templates/zerver/integrations/email.md pointing to help/using-zulip-via-email.md. We can no longer have that symlink since the latter has been converted to an MDX file. We have deleted the symlink and put a markdown file in it's place. Both the files have comments to edit the other in case of changes. This commit also makes changes in astro config, astro component paths and other places to move the starlight help center docs base path from /starlight_help to /help. The change to rename /starlight_help/ to /help/ in MDX files is done in the next commit. If we squash these commits, this line should be removed. `./tools/build-help-center` no longer does the conversion step. We also remove some dead code related to the old help center in documentation.py.
This commit is contained in:
Shubham Padia
committed by
Tim Abbott
Tim Abbott
parent
40f723c75a
commit
d333ddb961
@@ -6,7 +6,7 @@ import Icons from "unplugin-icons/vite";
|
||||
|
||||
// https://astro.build/config
|
||||
export default defineConfig({
|
||||
base: "starlight_help",
|
||||
base: "help",
|
||||
vite: {
|
||||
plugins: [
|
||||
// eslint-disable-next-line new-cap
|
||||
@@ -557,93 +557,88 @@ export default defineConfig({
|
||||
],
|
||||
// Redirects in astro are just directories with index.html inside
|
||||
// them doing the redirect we define in the value. The base of
|
||||
// /starlight_help/ will apply to the keys in the list below but we will
|
||||
// have to prepend /starlight_help/ in the redirect URL.
|
||||
// /help/ will apply to the keys in the list below but we will
|
||||
// have to prepend /help/ in the redirect URL.
|
||||
redirects: {
|
||||
"pm-mention-alert-notifications": "/starlight_help/dm-mention-alert-notifications",
|
||||
"restrict-private-messages": "/starlight_help/restrict-direct-messages",
|
||||
"reading-pms": "/starlight_help/direct-messages",
|
||||
"private-messages": "/starlight_help/direct-messages",
|
||||
"configure-who-can-edit-topics": "/starlight_help/restrict-moving-messages",
|
||||
"configure-message-editing-and-deletion":
|
||||
"/starlight_help/restrict-message-editing-and-deletion",
|
||||
"restrict-visibility-of-email-addresses": "/starlight_help/configure-email-visibility",
|
||||
"change-default-view": "/starlight_help/configure-default-view",
|
||||
"recent-topics": "/starlight_help/recent-conversations",
|
||||
"add-custom-profile-fields": "/starlight_help/custom-profile-fields",
|
||||
"enable-enter-to-send": "/starlight_help/configure-send-message-keys",
|
||||
"pm-mention-alert-notifications": "/help/dm-mention-alert-notifications",
|
||||
"restrict-private-messages": "/help/restrict-direct-messages",
|
||||
"reading-pms": "/help/direct-messages",
|
||||
"private-messages": "/help/direct-messages",
|
||||
"configure-who-can-edit-topics": "/help/restrict-moving-messages",
|
||||
"configure-message-editing-and-deletion": "/help/restrict-message-editing-and-deletion",
|
||||
"restrict-visibility-of-email-addresses": "/help/configure-email-visibility",
|
||||
"change-default-view": "/help/configure-default-view",
|
||||
"recent-topics": "/help/recent-conversations",
|
||||
"add-custom-profile-fields": "/help/custom-profile-fields",
|
||||
"enable-enter-to-send": "/help/configure-send-message-keys",
|
||||
"change-the-default-language-for-your-organization":
|
||||
"/starlight_help/configure-organization-language",
|
||||
"delete-a-stream": "/starlight_help/archive-a-channel",
|
||||
"archive-a-stream": "/starlight_help/archive-a-channel",
|
||||
"change-the-topic-of-a-message": "/starlight_help/rename-a-topic",
|
||||
"configure-missed-message-emails": "/starlight_help/email-notifications",
|
||||
"add-an-alert-word": "/starlight_help/dm-mention-alert-notifications#alert-words",
|
||||
"test-mobile-notifications": "/starlight_help/mobile-notifications",
|
||||
"/help/configure-organization-language",
|
||||
"delete-a-stream": "/help/archive-a-channel",
|
||||
"archive-a-stream": "/help/archive-a-channel",
|
||||
"change-the-topic-of-a-message": "/help/rename-a-topic",
|
||||
"configure-missed-message-emails": "/help/email-notifications",
|
||||
"add-an-alert-word": "/help/dm-mention-alert-notifications#alert-words",
|
||||
"test-mobile-notifications": "/help/mobile-notifications",
|
||||
"troubleshooting-desktop-notifications":
|
||||
"/starlight_help/desktop-notifications#troubleshooting-desktop-notifications",
|
||||
"change-notification-sound":
|
||||
"/starlight_help/desktop-notifications#change-notification-sound",
|
||||
"configure-message-notification-emails": "/starlight_help/email-notifications",
|
||||
"disable-new-login-emails": "/starlight_help/email-notifications#new-login-emails",
|
||||
"/help/desktop-notifications#troubleshooting-desktop-notifications",
|
||||
"change-notification-sound": "/help/desktop-notifications#change-notification-sound",
|
||||
"configure-message-notification-emails": "/help/email-notifications",
|
||||
"disable-new-login-emails": "/help/email-notifications#new-login-emails",
|
||||
// The `help/about-streams-and-topics` and `help/streams-and-topics` redirects are particularly
|
||||
// important, because the old URLs appear in links from Welcome Bot messages.
|
||||
"about-streams-and-topics": "/starlight_help/introduction-to-topics",
|
||||
"streams-and-topics": "/starlight_help/introduction-to-topics",
|
||||
"community-topic-edits": "/starlight_help/restrict-moving-messages",
|
||||
"only-allow-admins-to-add-emoji":
|
||||
"/starlight_help/custom-emoji#change-who-can-add-custom-emoji",
|
||||
"configure-who-can-add-custom-emoji":
|
||||
"/starlight_help/custom-emoji#change-who-can-add-custom-emoji",
|
||||
"add-custom-emoji": "/starlight_help/custom-emoji",
|
||||
"night-mode": "/starlight_help/dark-theme",
|
||||
"enable-emoticon-translations": "/starlight_help/configure-emoticon-translations",
|
||||
"web-public-streams": "/starlight_help/public-access-option",
|
||||
"starting-a-new-private-thread": "/starlight_help/starting-a-new-direct-message",
|
||||
"edit-or-delete-a-message": "/starlight_help/delete-a-message",
|
||||
"start-a-new-topic": "/starlight_help/starting-a-new-topic",
|
||||
"configure-default-view": "/starlight_help/configure-home-view",
|
||||
"reading-topics": "/starlight_help/reading-conversations",
|
||||
"finding-a-topic-to-read": "/starlight_help/finding-a-conversation-to-read",
|
||||
"view-and-browse-images": "/starlight_help/view-images-and-videos",
|
||||
"bots-and-integrations": "/starlight_help/bots-overview",
|
||||
"configure-notification-bot": "/starlight_help/configure-automated-notices",
|
||||
"all-messages": "/starlight_help/combined-feed",
|
||||
"create-streams": "/starlight_help/create-channels",
|
||||
"create-a-stream": "/starlight_help/create-a-channel",
|
||||
"message-a-stream-by-email": "/starlight_help/message-a-channel-by-email",
|
||||
"browse-and-subscribe-to-streams": "/starlight_help/browse-and-subscribe-to-channels",
|
||||
"unsubscribe-from-a-stream": "/starlight_help/unsubscribe-from-a-channel",
|
||||
"view-stream-subscribers": "/starlight_help/view-channel-subscribers",
|
||||
"add-or-remove-users-from-a-stream": "/starlight_help/subscribe-users-to-a-channel",
|
||||
"pin-a-stream": "/starlight_help/pin-a-channel",
|
||||
"change-the-color-of-a-stream": "/starlight_help/change-the-color-of-a-channel",
|
||||
"move-content-to-another-stream": "/starlight_help/move-content-to-another-channel",
|
||||
"manage-inactive-streams": "/starlight_help/manage-inactive-channels",
|
||||
"stream-notifications": "/starlight_help/channel-notifications",
|
||||
"mute-a-stream": "/starlight_help/mute-a-channel",
|
||||
"manage-user-stream-subscriptions": "/starlight_help/manage-user-channel-subscriptions",
|
||||
"stream-permissions": "/starlight_help/channel-permissions",
|
||||
"stream-sending-policy": "/starlight_help/channel-posting-policy",
|
||||
"configure-who-can-create-streams": "/starlight_help/configure-who-can-create-channels",
|
||||
"configure-who-can-invite-to-streams":
|
||||
"/starlight_help/configure-who-can-invite-to-channels",
|
||||
"set-default-streams-for-new-users": "/starlight_help/set-default-channels-for-new-users",
|
||||
"rename-a-stream": "/starlight_help/rename-a-channel",
|
||||
"change-the-stream-description": "/starlight_help/change-the-channel-description",
|
||||
"change-the-privacy-of-a-stream": "/starlight_help/change-the-privacy-of-a-channel",
|
||||
"channels-and-topics": "/starlight_help/introduction-to-topics",
|
||||
"starting-a-new-topic": "/starlight_help/introduction-to-topics#how-to-start-a-new-topic",
|
||||
"about-streams-and-topics": "/help/introduction-to-topics",
|
||||
"streams-and-topics": "/help/introduction-to-topics",
|
||||
"community-topic-edits": "/help/restrict-moving-messages",
|
||||
"only-allow-admins-to-add-emoji": "/help/custom-emoji#change-who-can-add-custom-emoji",
|
||||
"configure-who-can-add-custom-emoji": "/help/custom-emoji#change-who-can-add-custom-emoji",
|
||||
"add-custom-emoji": "/help/custom-emoji",
|
||||
"night-mode": "/help/dark-theme",
|
||||
"enable-emoticon-translations": "/help/configure-emoticon-translations",
|
||||
"web-public-streams": "/help/public-access-option",
|
||||
"starting-a-new-private-thread": "/help/starting-a-new-direct-message",
|
||||
"edit-or-delete-a-message": "/help/delete-a-message",
|
||||
"start-a-new-topic": "/help/starting-a-new-topic",
|
||||
"configure-default-view": "/help/configure-home-view",
|
||||
"reading-topics": "/help/reading-conversations",
|
||||
"finding-a-topic-to-read": "/help/finding-a-conversation-to-read",
|
||||
"view-and-browse-images": "/help/view-images-and-videos",
|
||||
"bots-and-integrations": "/help/bots-overview",
|
||||
"configure-notification-bot": "/help/configure-automated-notices",
|
||||
"all-messages": "/help/combined-feed",
|
||||
"create-streams": "/help/create-channels",
|
||||
"create-a-stream": "/help/create-a-channel",
|
||||
"message-a-stream-by-email": "/help/message-a-channel-by-email",
|
||||
"browse-and-subscribe-to-streams": "/help/browse-and-subscribe-to-channels",
|
||||
"unsubscribe-from-a-stream": "/help/unsubscribe-from-a-channel",
|
||||
"view-stream-subscribers": "/help/view-channel-subscribers",
|
||||
"add-or-remove-users-from-a-stream": "/help/subscribe-users-to-a-channel",
|
||||
"pin-a-stream": "/help/pin-a-channel",
|
||||
"change-the-color-of-a-stream": "/help/change-the-color-of-a-channel",
|
||||
"move-content-to-another-stream": "/help/move-content-to-another-channel",
|
||||
"manage-inactive-streams": "/help/manage-inactive-channels",
|
||||
"stream-notifications": "/help/channel-notifications",
|
||||
"mute-a-stream": "/help/mute-a-channel",
|
||||
"manage-user-stream-subscriptions": "/help/manage-user-channel-subscriptions",
|
||||
"stream-permissions": "/help/channel-permissions",
|
||||
"stream-sending-policy": "/help/channel-posting-policy",
|
||||
"configure-who-can-create-streams": "/help/configure-who-can-create-channels",
|
||||
"configure-who-can-invite-to-streams": "/help/configure-who-can-invite-to-channels",
|
||||
"set-default-streams-for-new-users": "/help/set-default-channels-for-new-users",
|
||||
"rename-a-stream": "/help/rename-a-channel",
|
||||
"change-the-stream-description": "/help/change-the-channel-description",
|
||||
"change-the-privacy-of-a-stream": "/help/change-the-privacy-of-a-channel",
|
||||
"channels-and-topics": "/help/introduction-to-topics",
|
||||
"starting-a-new-topic": "/help/introduction-to-topics#how-to-start-a-new-topic",
|
||||
"browse-and-subscribe-to-channels":
|
||||
"/starlight_help/introduction-to-channels#browse-and-subscribe-to-channels",
|
||||
"allow-image-link-previews": "/starlight_help/image-video-and-website-previews",
|
||||
"getting-your-organization-started-with-zulip": "/starlight_help/moving-to-zulip",
|
||||
"quote-and-reply": "/starlight_help/quote-or-forward-a-message",
|
||||
"change-a-users-role": "/starlight_help/user-roles",
|
||||
"roles-and-permissions": "/starlight_help/user-roles",
|
||||
"add-or-remove-users-from-a-channel": "/starlight_help/subscribe-users-to-a-channel",
|
||||
"disable-message-edit-history": "/starlight_help/restrict-message-edit-history-access",
|
||||
"edit-a-bot": "/starlight_help/manage-a-bot",
|
||||
"reading-dms": "/starlight_help/direct-messages",
|
||||
"/help/introduction-to-channels#browse-and-subscribe-to-channels",
|
||||
"allow-image-link-previews": "/help/image-video-and-website-previews",
|
||||
"getting-your-organization-started-with-zulip": "/help/moving-to-zulip",
|
||||
"quote-and-reply": "/help/quote-or-forward-a-message",
|
||||
"change-a-users-role": "/help/user-roles",
|
||||
"roles-and-permissions": "/help/user-roles",
|
||||
"add-or-remove-users-from-a-channel": "/help/subscribe-users-to-a-channel",
|
||||
"disable-message-edit-history": "/help/restrict-message-edit-history-access",
|
||||
"edit-a-bot": "/help/manage-a-bot",
|
||||
"reading-dms": "/help/direct-messages",
|
||||
},
|
||||
});
|
||||
|
||||
@@ -3,7 +3,7 @@ import {CORPORATE_ENABLED, SUPPORT_EMAIL} from "astro:env/client";
|
||||
|
||||
let footer_html = `<p>Don't see an answer to your question? <a href="mailto:${SUPPORT_EMAIL}">Contact this Zulip server's administrators</a> for support.</p>`;
|
||||
if (CORPORATE_ENABLED) {
|
||||
footer_html = `<p>Your feedback helps us make Zulip better for everyone! Please <a href="/starlight_help/contact-support">contact us</a> with questions, suggestions, and feature requests.</p>`;
|
||||
footer_html = `<p>Your feedback helps us make Zulip better for everyone! Please <a href="/help/contact-support">contact us</a> with questions, suggestions, and feature requests.</p>`;
|
||||
}
|
||||
---
|
||||
|
||||
|
||||
@@ -6,6 +6,13 @@ import { Steps } from '@astrojs/starlight/components';
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
{/*
|
||||
Any changes to this file should be reflected in
|
||||
templates/zerver/integrations/email.md and vice versa.
|
||||
That file used to be a symlink to the current file before we converted
|
||||
it to mdx.
|
||||
*/}
|
||||
|
||||
With Zulip, it is possible for some members of your organization to participate
|
||||
from their email client, without opening the Zulip app after the initial
|
||||
setup is complete.
|
||||
|
||||
Reference in New Issue
Block a user