paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-22 20:42:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

help: Rename --help-center to --help-center-static-build for run-dev.

Browse Source 
Having it name --help-center made it sound like it was the default mode.
The new name reflects that option more accurately.
This commit is contained in:
Shubham Padia
2025-09-11 15:16:31 +00:00
committed by Tim Abbott
parent b79b068568
commit 3b6d8de815
3 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
templates/zerver/development/dev_tools.html
View File

@@ -166,7 +166,7 @@
<h3> Serve static build (supports search but not hot reload)</h3>
<p>
Please run <code>./tools/build-help-center</code> to generate a static build of the help center.
<code>./tools/run-dev --help-center</code> will host the generated build on
<code>./tools/run-dev --help-center-static-build</code> will host the generated build on
<code>/help</code>. Note that you need to generate a build and pass the flag mentioned for the search
to work.
</p>

2
tools/lib/test_server.py
View File

@@ -77,7 +77,7 @@ def test_server_running(
if skip_provision_check:
run_dev_server_command.append("--skip-provision-check")
if enable_help_center:
run_dev_server_command.append("--help-center")
run_dev_server_command.append("--help-center-static-build")
server = subprocess.Popen(run_dev_server_command, stdout=log, stderr=log)
try:

12
tools/run-dev
View File

@@ -66,7 +66,9 @@ parser.add_argument(
help="Start app server in HTTPS mode, using reverse proxy",
)
parser.add_argument(
"--help-center", action="store_true", help="Build and host help center with search"
"--help-center-static-build",
action="store_true",
help="Host existing static build of help center with search",
)
parser.add_argument(
"--help-center-dev-server",
@@ -80,7 +82,9 @@ parser.add_argument(
)
add_provision_check_override_param(parser)
options = parser.parse_args()
help_center_dev_server_enabled = options.help_center_dev_server and not options.help_center
help_center_dev_server_enabled = (
options.help_center_dev_server and not options.help_center_static_build
)
assert_provisioning_status_ok(options.skip_provision_check)
@@ -333,7 +337,7 @@ async def help_center_middleware(
middlewares = []
if options.help_center:
if options.help_center_static_build:
middlewares.append(help_center_middleware)
app = web.Application(middlewares=middlewares)
@@ -458,7 +462,7 @@ async def serve() -> None:
if help_center_dev_server_enabled:
children.append(run_help_center_dev_server(external_host_url))
setup_routes(options.help_center, options.help_center_dev_server)
setup_routes(options.help_center_static_build, options.help_center_dev_server)
children.extend(subprocess.Popen(cmd) for cmd in server_processes())