The sidebar index was an includes file in our previous help center since
we were using it to programmatically in documentation.py. Since that is
no longer the case, there is no reason for this file to be in includes.
A side-effect of us doing this is that now the overview section on the
right for the index page will be generated correctly with us avoiding
the issue in #35127.
Fixes#35533.
We could not convert them in the source markdown files since removing
the preceding line for tips and tables was breaking our custom markdown
implementation.
We have a copy of help center with relative links disabled which is
reserved for root domains without an organisation on the root domain.
Ideally, we should have some logic to determine whether we are on such
a root domain or not. For practical short term purposes, since this
type of documentation is mainly useful for zulip.com, we add an
exception for zulip.com.
Fixes#35131.
Most of the nginx config is copied from
https://docs.astro.build/en/recipes/docker/#nginx.
We ideally should be generating two builds for Zulip cloud and serve a
different one depending on whether the subdomain is same as the root
domain or not. We can look into this as an immediate followup while this
commit helps things get ready for a test deploy on CZO.
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.
We have not yet removed the help files. We can use this commit as a
conversion commit since a lot more help changes will be merged before
this PR gets merged. We will need to rebase on top of main, run
conversion step in this commit, push those changes and then merge the
PR.
NOTE: This commit temporarily breaks the astro build since we have
renamed the path in the MDX files from starlight_help/ to help/ early.
That should be fine since astro build will not break any tests right
now.
We should squash this commit with the next commit removing help center
files when merging into main and remove this NOTE.
Fixes#35649.
We do not serve the astro build via Django and thus we have to move the
help center redirects. We get a warning by pagefind on all these
redirects that they will be ignored in the search results as they don't
have an HTML body. We can ignore this warning till the cutover and
create a followup issue to solve that warning if this commit goes
through main.
When we copied over the logic for the footer from the previous help
center, I forgot to remove the double curly braces which were getting
rendered as is in astro.
@types/mdast was in dev dependencies while it shouldn't have been, we
move that away from dev dependencies and bump the version. We need the
package when running the astro build step.
Partially fixes#35435.
For KeyboardTip.astro and ZulipTip.astro, we were using type assertions
and thus needed to suppress eslint warnings that were being thrown.
We could also have one underlying component powering all of our custom
aside components. The code duplication between KeyboardTip and ZulipTip
is high. We are holding off on having that underlying component since
that component looks really complex compared to having 2 separate
components now. If we feel the duplication is a major issue later on,
combining them shouldn't be too much of an hassle.
The favicon should ideally change for self-hosted organizations if they
have configured it. We track the work for this in #35681 to look at
after the cutover.
We are starting the cutover process and starlight_help is the directory
we have agreed on to place our new help center project. We do not want
to use `starlight_help` as the URL for the project, but this commit
changes the url from `help-beta` to `starlight_help` temporarily since
we can only change URL once we get rid of the current help center
project. That will be done in a future commit.
