camunda/camunda-bpm-platform

Make Google crawl Optimize 7 docs

Closed this issue · 2 comments

mboskamp commented

Acceptance Criteria (Required on creation)

The search in the Optimize 7 docs is currently not functional. This is because it's based on Google and it's ability to index the pages.
We need to

  • Add the sitemap.xml to the Google Search Console
  • Make sure to update the path on every minor release (3.15)

Hints

  • The current sitemap.xml shows errors in the Google Search Console because of incomplete paths (/optimize/3.14/user-guide/homepage/ instead of https://docs.camunda.org/optimize/3.14/user-guide/homepage/)

Links

Breakdown

Pull Requests
Preview Give feedback

Dev2QA handover

  • Does this ticket need a QA test and the testing goals are not clear from the description? Add a Dev2QA handover comment
mboskamp commented

In the Google Search Console, I added the sitemap.xml of the 3.14 branch (that's the version we want to index). However, Google shows errors for that file because the URL is incomplete. It's missing https://docs.camunda.org and only contains the path from /optimize/....

The sitemap is generated by hugo and relies on the canonicalBasePath parameter. We can add this parameter in the config.yaml. See camunda-docs-manual for an example.

I won't add the property to older branches because we will most probably not want to index those ever.