camunda-modeler icon indicating copy to clipboard operation
camunda-modeler copied to clipboard

Use static links for documentation

Open marstamm opened this issue 3 years ago • 0 comments

Is your feature request related to a problem? Please describe.

We are currently link to sites in the cloud docs that might change with restructurings. In some cases, we even reference a specific subheading.

Should the structure or even wording change, we either need to update the links or a redirect has to be created. Over the long run, more redirects are added which might not be maintainable.

cf. #2769

Describe the solution you'd like

Instead, use a static link that always redirects to a specific page, e.g.

  • docs.camunda.io/ref/modeler-1111 -> docs.camunda.io/docs/components/modeler/bpmn/timer-events/#time-duration
  • docs.camunda.io/ref/modeler-timer -> docs.camunda.io/docs/components/modeler/bpmn/timer-events/#time-duration
  • ...

This ensures that the links continue to work in all modeler versions and always reference a valid site. Also, the number of redirects to be maintained is static.

Describe alternatives you've considered

Keep the current process of adding redirects when sites go dead.

marstamm avatar Feb 22 '22 10:02 marstamm