Revive Optimize 7 documentation

[mboskamp]

Acceptance Criteria (Required on creation)

As a user of Optimize in Camunda 7, I want to have all relevant information around Optimize as part of the Camunda 7 documentation (https://docs.camunda.org/optimize/latest/)

Hints

• Optimize 3.8 was the latest version published at https://docs.camunda.org/optimize (could be restored via git log)
• Starting from Optimize 3.9, the documentation lived at https://docs.camunda.io and was overhauled to better apply to Camunda 8 use cases.

Links

• https://github.com/camunda/developer-experience/issues/407

Breakdown

Tasks

Preview Give feedback

1. Revive 3.7 and 3.8 branches of Optimize 7 documentation #4763
   2 of 2
   type:subtask +1
   
2. Move redirect rules from C7 Optimize to C8 Optimize docs into C7 repositories #4765
   1 of 1
   type:subtask +1
   
3. Create documentation branches for Optimize 3.11, 3.12, 3.13, and 3.14 #4772
   4 of 4
   type:subtask +1
   
4. Create jenkins jobs for new Optimize 7 branches #4766
   1 of 1
   type:subtask +1
   
5. Create update notes for Optimize 3.11, 3.12, 3.13, and 3.14 #4781
   type:subtask +1
   
6. Migrate important content from Optimize 8 documentation to Optimize 7 3.14 #4780
   5 of 5
   type:subtask +1
   
7. Release docs branches #4798
   type:subtask +1
   
8. Plausibility check of new Optimize 7 docs #4797
   type:subtask +1
   
9. Create C8 header #4831
   +0
   
10. Follow-up: Clean up Optimize documentation content #4833
    6 of 6
    +0
    
11. Make Google crawl Optimize 7 docs #4845
    2 of 2
    scope:documentation scope:optimize type:task version:optimize 3.14.2 version:optimize 3.15.0 +5
    

Follow-ups

Preview Give feedback

1. Make documentation branches for all supported versions of Optimize accessible from any branch #4803
   scope:documentation type:subtask +2
   
2. Migrate links in Optimize 7 docs to hugo-based makro #4823
   scope:documentation type:subtask +2
   
3. Redirects for Modeler documentation pages to Camunda 8 docs are broken #4775
   scope:documentation type:bug +2
   
4. Follow-up: Clean up Optimize documentation content - nice-to-have #4835
   scope:documentation scope:optimize type:subtask +3
   
5. Deprecated config default docs link points to C8 docs #4782
   4 of 4
   scope:documentation scope:optimize type:task version:optimize 3.14.2 version:optimize 3.15.0 +5
   

Dev2QA handover

• Does this ticket need a QA test and the testing goals are not clear from the description? Add a Dev2QA handover comment

[mboskamp]

What happened so far?

• Restored Git Log for 3.8 (PR) and 3.7.
• Tested the docs locally.
• Adjust deprecation notices in README. It should mention the different docs sources for Optimize 7 and 8.
• Duplicate 3.8 as 3.14 (we will skip unsupported versions in between).
• Add 3.7, 3.8, and 3.14 to the docs pages.
• Reached out to devex to learn what they already know about/plan to do with the Optimize 7 documentation at docs.camunda.io.
• 3.7 and 3.8 PRs are in review merged. Those are handled in a subtask.
• Reached out to DevEx to ask about the origin of the Optimize 7 redirects to the Optimize 8 documentation.
• Remove redirects to docs.camunda.io
  • Redirects are handled in the vhost file of the machine hosting the two documentation spaces
  • Together with DevEx and IT, we agreed to migrate those redirect rules to the docs-static .htaccess files.
  • Created a PR to copy the redirect rules from the webserver's vhost file to our htaccess files. This will be handled in a subtask.
• Created version branches for 3.11-3.14. 3.11 is based on 3.8. after 3.11 the version branches are based on the previous version branch.
  • Updated the supported environments for each branch according to the Optimize docs in the C8 space.
• Created stage and release jobs for 3.11-3.14 and released all the new branches. They are live but not visible from latest because that branch is still old.
• Migrated update notes for 3.11-3.14 branches from C8 docs.
• Migrated important content from C8 docs to the 3.14 branch.
• Set 3.14 state as master and latest

What's next?

• Get feedback on the migrated content.

Decision:

• We will not restore unsupported versions after 3.8 (3.9, 3.10)
  • Open question: Will the C8 docs be cleaned from C7 Optimize on all branches? (i.e. also on unsupported Optimize version branches)

[mboskamp]

The plausibility check can be done after merging and releasing all branches.

[mboskamp]

Closing this issue. All must-have issues are implemented. The follow-ups will be done when necessary.