mirror of
https://github.com/zulip/zulip.git
synced 2025-10-22 20:42:14 +00:00
c3fbe00eb0
We've copied the button and error colors from portico_signin.css. We did not want the new HTML file to depend on portico_signin.css since they are unrelated. In addition, having those colors diverge over time might not be an issue. We make the raw mode work with /help and /help/ both. See https://chat.zulip.org/#narrow/channel/19-documentation/topic/edits.20not.20appearing.20with.20vagrant/near/2257442 Co-authored-by: Alya Abbott <alya@zulip.com>
61 lines
2.6 KiB
HTML
61 lines
2.6 KiB
HTML
{% extends "zerver/portico.html" %}
|
|
{% set entrypoint = "dev-help" %}
|
|
|
|
{% block title %}
|
|
<title>Help center server not running | Zulip Dev</title>
|
|
{% endblock %}
|
|
|
|
{% block portico_content %}
|
|
|
|
<div class="dev-help-page flex">
|
|
<div class="white-box markdown">
|
|
{% if mdx_file_exists %}
|
|
<h2 class="dev-help-header">Help center server not running</h2>
|
|
<p>
|
|
To minimize resource requirements for the development
|
|
environment, the help center's development server does
|
|
not run by default. Below are our recommendations for
|
|
accessing this help center page:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<b>Quick reference</b>: If you aren't planning to modify the help center, you can
|
|
<a target="_blank" rel="noopener noreferrer"
|
|
href="https://zulip.com/help/{{ subpath }}">view it on
|
|
zulip.com</a>. Pages may be slightly behind the version
|
|
currently in <code>main</code>.
|
|
</li>
|
|
<li>
|
|
<b>Up-to-date reference</b>: You can
|
|
<a target="_blank" rel="noopener noreferrer" href="{{
|
|
raw_url }}">view the current raw MDX file</a>, which is recommended for documentation
|
|
that touches brand new or recently modified features.
|
|
</li>
|
|
<li>
|
|
<b>Modifying the help center</b>: If you're making changes to
|
|
the help center files, be sure to <b>test</b> and provide
|
|
screenshots in your pull request description. As
|
|
with other code, untested documentation is often buggy.
|
|
{% include "zerver/development/help_center_instructions_macro.html" %}
|
|
</li>
|
|
</ul>
|
|
{% else %}
|
|
<p class="invalid-path-error">
|
|
This is not a valid help path and not a valid MDX file. Please re-check the URL subpath you have provided.
|
|
</p>
|
|
{% endif %}
|
|
|
|
<div class="dev-help-actions">
|
|
{% if mdx_file_exists %}
|
|
<a target="_blank" rel="noopener noreferrer" href="https://zulip.com/help/{{ subpath }}" class="dev-help-action-button">
|
|
View page on zulip.com
|
|
</a>
|
|
<a target="_blank" rel="noopener noreferrer" href="{{ raw_url }}" class="dev-help-action-button">
|
|
View page source
|
|
</a>
|
|
{% endif %}
|
|
</div>
|
|
</div>
|
|
</div>
|
|
{% endblock %}
|