Migrate important content from Optimize 8 documentation to Optimize 7 3.14

[mboskamp]

Acceptance Criteria (Required on creation)

The Optimize 3.14 documentation branch is a copy of the 3.8 branch. We need to identify major updates and migrate them on a best-effort basis. We can always iterate and migrate more in the future.

Hints

Links

Breakdown

Pull Requests

Beta Give feedback

1. https://github.com/camunda/camunda-docs-optimize/pull/342
2. https://github.com/camunda/camunda-docs-optimize/pull/350
3. https://github.com/camunda/camunda-docs-optimize/pull/343
4. https://github.com/camunda/camunda-docs-optimize/pull/344
5. https://github.com/camunda/camunda-docs-optimize/pull/345

[mboskamp]

What content do we want to migrate?

• Update/Migration guides
• Dependency Information
• Installation guide
• Features
  • OpenSearch support: This feature has impact on many aspects of the documentation. It's an alternative DB (next to Elasticsearch), so in all places where we talk about Elasticsearch, we need to include OpenSearch or generically talk about "databases".
  • other features?

What happened so far?

• Updated configuration properties for 3.11-3.14
• Updated dependency information for 3.11-3.14
• Updated migration guide for 3.7-3.14
• Cherry-pick migration guides to 3.11-3.13 feature branches
• Added information about OpenSearch for 3.14 and 3.13
• Went through completed features in the GitHub issue tracker and Jira (which was used until 3.11.0) looking for completed features that introduced documentation.
  • Ignored:
    • hint about session storage
    • clarification about export data
    • camunda-maintained dashboards
  • Already covered (e.g. config flags):
    • Skip hostname verification
    • Proxy settings for webhook notifications
  • Additionally migrated:
    • JSON logging
      • Released with 3.10
      • C8 docs
      • C7 docs
    • non-superusers can export
      • Released with 3.10.0
      • C8 docs
      • C7 docs
    • ML-ready dataset
      • Released with 3.10
      • C8 docs
    • Backup/Restore (several commits, e.g. but we should migrate the full page)
      • Released with 3.10
      • C8 docs
      • Documents REST endpoint -> Should go into REST docs

[mboskamp]

I don't intend to squash the commits in the PRs. It will be helpful to have the history on the branches. We would have a similar history if the branches had been created through a regular release.

[mboskamp]

@psavidis, I did not try out the Python link validator. However, I tested the pages with broken links and found no issues.
I had to battle with Git a lot to get a clean history. All the hashes are probably different due to history rewrites.
The main changes are:

• fixed broken links (mainly on migration pages)
• added all versions (3.11-3.14) to the version navigation dropdown on all branches (Make documentation branches for all supported versions of Optimize accessible from any branch #4803)
• removed duplicated Camunda 7 version (e.g. Camunda 7 7.22.0 -> Camunda 7.22.0)

[psavidis]

Hey @mboskamp,

I used a small python script locally and was still able to find occurrences across pages so i stopped counting them all one by one.

I've approved the pull requests for now since content-wise, the pull requests look good to me. However, the broken links despite not critical still have to be fixed eventually.

The sheer size of content that needs migration renders both the review and fixing it difficult and time consuming. To assist this effort, i'd like to recommend the following :

a) Since the content looks ok, you can either create a separate task to fix broken links across all the pages using a parent branch which can in the end be merged to the respective branches

b) Merge directly, let the CI fail to detect the broken links and fix them in a follow-up.

Feel free to decide whatever works for you best.

[mboskamp]

After discussing with @psavidis we decided to

• merge the PRs as they are right now
• check if the broken links on stage break are detected by the link checker
• check if any other links are broken
• create a follow-up ticket to
  • convert all relative links to use the custom hugo snippet ({{< ref "" >}}, there are about 100 of these)

[mboskamp]

@psavidis, I merged the 3.14 branch and fixed the seven reported broken links. Please have a look at this follow-up PR for 3.14 and the 3.13 PR. It was possible to cherry-pick the 3.13 commit to 3.12 and 3.11, so no additional review is necessary there in my opinion.

[psavidis]

Review of 3.14, 3.13 is done. Since the cherry pick is the same for the other two PRs, the merging can proceed with them as well 👍

[mboskamp]

CI looks good on all branches.