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

archive (1.3) exclude: remove versions 1.3 and 3.7.0, part 1: reviewable steps

Open pepopowitz opened this issue 2 years ago • 4 comments

🛑 BLOCKED 🛑

  • [x] The unsupported/1.3 site is not yet in production.
  • [x] The version dropdown is confusing when viewing an Optimize doc! I'm intending to resolve in this PR, see comments.
  • [ ] OpenSearch is not yet supported in C8 Optimize (OpenSearch support is tracked at a platform level at https://github.com/camunda/product-hub/issues/997. Optimize support is tracked at https://github.com/camunda/product-hub/issues/1908.)

We should check back when #2432 is complete, to see if OpenSearch support has been included in Optimize. If it has, we can complete this issue. If it has not, we should schedule a reminder to check again a month or so later.

Description

Part of #2189.

Includes the smaller items for removing version 1.3 from the main docs, to keep the PR in a reviewable state.

Included in this PR

  • Remove v1.3 & Optimize v3.7.0 from the version manifest files, so that they're not included in the deployed site
  • Redirect all 1.3 / 3.7.0 traffic to unsupported.docs.camunda.io/1.3 (or stage.unsupported.docs.camunda.io/1.3 for the staging build)
  • Move 1.3 to the "Unsupported versions" sub-list in the top nav version selector, redirecting to unsupported.docs.camunda.io/1.3.
    • The label for this version combines both the main version & Optimize version. This combined version label shows when viewing both a main doc (shown below on the left side) and an Optimize doc (shown below on the right side):

      image

When should this change go live?

  • [ ] This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • [x] There is no urgency with this change.
  • [ ] This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • [ ] This functionality is already available but undocumented.
  • [ ] This is a bug fix or security concern.

PR Checklist

  • [x] I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • [x] I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • [x] My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • [x] My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

pepopowitz avatar Aug 28 '23 20:08 pepopowitz

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Oct 05 '23 08:10 CLAassistant

@pepopowitz are you aware of the status of Optimize 1.3? Will this be included with the January minor release?

akeller avatar Dec 12 '23 17:12 akeller

@pepopowitz are you aware of the status of Optimize 1.3? Will this be included with the January minor release?

OpenSearch for Optimize is tracked at https://github.com/camunda/product-hub/issues/1908. It is targeting 8.5.

(I'll update this issue to include a link to the Optimize-specific Product Hub issue.)

pepopowitz avatar Dec 12 '23 21:12 pepopowitz

This remains blocked. See internal update - https://camunda.slack.com/archives/C02AWA0RF8A/p1710317097178729?thread_ts=1703089659.451659&cid=C02AWA0RF8A

akeller avatar Mar 13 '24 18:03 akeller

@pepopowitz, is your plan to resurrect this PR or open a new one?

akeller avatar Aug 16 '24 16:08 akeller

we should definitely close this and re-create later.

pepopowitz avatar Aug 19 '24 21:08 pepopowitz