Discourse Doc Categories

:loudspeaker: Updates for self-hosters

For self-hosters using this plugin, our most recent update would require a manual rebuild of the index. This would involve running this rake task:

bundle exec rake doc_categories:build_sidebar

# if running the task above fails due to NoDatabaseError,
# run with the following for typical self-hosted setups
sudo -E -u discourse bundle exec rake doc_categories:build_sidebar

If you are not able to run this rake task, you may go to each documentation category’s settings, remove the category index, save, add it back, and save. This would rebuild them and refresh the category cache as well.


Why are we doing this?

Previously, when the sidebar had to be populated, we will parse each index topic on the fly, and cache them. This update moves the existing indexes to be backed by the database instead of a topic. Doing so exposes our team to more options when thinking of ways to improve the UX of organising the index.

9 Likes