Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sitemap to Docusaurus #3165

Merged
merged 1 commit into from
Mar 11, 2022
Merged

Add sitemap to Docusaurus #3165

merged 1 commit into from
Mar 11, 2022

Conversation

tcvan0707
Copy link
Contributor

Issue This PR Addresses

Fixes #2926

Type of Change

  • Bugfix: Change which fixes an issue
  • New Feature: Change which adds functionality
  • Documentation Update: Change which improves documentation
  • UI: Change which improves UI

Description

This PR will add the sitemap plugin for Docusaurus, and it will create sitemaps so search engine crawlers can crawl our docs website more accurately.

Based on the docs:

This plugin is always inactive in development and only active in production because it works on the build output.

Because of that, right now I am not sure how to test this one locally yet.

Checklist

  • Quality: This PR builds and passes our npm test and works locally
  • Tests: This PR includes thorough tests or an explanation of why it does not
  • Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not (if applicable)
  • Documentation: This PR includes updated/added documentation to user exposed functionality or configuration variables are added/changed or an explanation of why it does not(if applicable)

@gitpod-io
Copy link

gitpod-io bot commented Mar 10, 2022

cindyorangis
cindyorangis previously approved these changes Mar 10, 2022
Copy link
Contributor

@cindyorangis cindyorangis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, we need #2993 to be resolved before we can test this on staging and production but I believe this is all we need to get done for the sitemap.

Copy link
Contributor

@humphd humphd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we not need to install this plugin and have it added to package.json? https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap

@tcvan0707
Copy link
Contributor Author

Do we not need to install this plugin and have it added to package.json? https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap

We are using @docusaurus/preset-classic, so we don't need to install plugin-sitemap as a dependency. We just need to configure this plugin inside the preset option

humphd
humphd previously approved these changes Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docusaurus Anything related to Docusaurus
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add sitemap to Docusaurus website
5 participants