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

Remove Search from unsupported versions #2475

Closed
7 tasks done
Tracked by #1173
pepopowitz opened this issue Aug 21, 2023 · 1 comment
Closed
7 tasks done
Tracked by #1173

Remove Search from unsupported versions #2475

pepopowitz opened this issue Aug 21, 2023 · 1 comment
Assignees
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

Comments

@pepopowitz
Copy link
Collaborator

pepopowitz commented Aug 21, 2023

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

  1. dx epic:archive-old-versions kind/cleanup
    pepopowitz
  2. dx epic:archive-old-versions kind/cleanup
    pepopowitz
  3. dx epic:archive-old-versions kind/cleanup
    pepopowitz
  4. dx epic:archive-old-versions kind/cleanup
    pepopowitz
  5. dx epic:archive-old-versions kind/cleanup
    pepopowitz
  6. dx epic:archive-old-versions kind/cleanup
    pepopowitz
  7. dx epic:archive-old-versions kind/feature
    pepopowitz

Alternatives

  1. Figure out how to make the search results in the correct versioned format.

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:

  • This would take the most effort out of all suggestions discussed.
  • There would still be a chance that a URL was incorrect -- if the target doc's URL did not match in production vs the unsupported version (e.g. it was moved).
  1. Add redirect rules to an unsupported site's htaccess.

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:

  • There would still be a chance that a URL was incorrect -- if the target doc's URL did not match in production vs the unsupported version (e.g. it was moved).
@pepopowitz pepopowitz self-assigned this Aug 21, 2023
@pepopowitz pepopowitz added kind/cleanup Issues related with clean-up the documentation component:docs Documentation improvements, including new or updated content dx Documentation infrastructure typically handled by the Camunda DX team epic:build-time epic:archive-old-versions and removed epic:build-time labels Aug 21, 2023
@pepopowitz pepopowitz moved this from 🆕 Inbox to 🔖 Ready in Developer Experience Aug 21, 2023
@akeller
Copy link
Member

akeller commented Aug 22, 2023

Given the relatively low use of search (historically and currently, compared to page view traffic), your proposal makes a lot of sense to me. Let's not invest time in fixing this for each site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
Archived in project
Development

No branches or pull requests

2 participants