Remove Search from unsupported versions #2475
Labels
component:docs
Documentation improvements, including new or updated content
dx
Documentation infrastructure typically handled by the Camunda DX team
epic:archive-old-versions
kind/cleanup
Issues related with clean-up the documentation
Part of #1173.
The Search results in unsupported versions are unhelpful. They are generated based on the main docs site (docs.camunda.io), which uses a different URL schema for versioning than the unsupported sites. As a result, the version number appears twice in each search result URL.
Example
Searching for "BPMN primer" on https://unsupported.docs.camunda.io/1.2/ gives the following top result: https://unsupported.docs.camunda.io/1.2/docs/1.2/reference/bpmn-processes/bpmn-primer/.
That URL does not exist. On the main site, the URL would be docs/1.2/reference/bpmn-processes/bpmn-primer/....on the unsupported site, the URL would be 1.2/docs/reference/bpmn-processes/bpmn-primer/. Instead, we get a hybrid that leads to a 404.
Proposal
Since these docs are for unsupported versions only, we should remove the Search entirely. It's not helping anyone, and it is non-trivial to fix.
Progress
Alternatives
There is probably a way to swizzle the Search components and remove the duplicate version number from the target URL.
The down-sides to this approach are:
One rewrite rule would cover everything -- it would look for the duplicate version number, and rewrite the URL without it.
The down-side of this approach is:
The text was updated successfully, but these errors were encountered: