Remove Optimize C7 content #4785
Conversation
akeller
added
component:optimize
|
👋 🤖 🤔 Hello, @akeller! Did you make your changes in all the right places? These files were changed only in optimize/. You might want to duplicate these changes in optimize_versioned_docs/version-3.14.0/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -4,6 +4,8 @@ title: "Version policy" | |||
| description: "Learn about the versioning policy for Camunda Optimize." | |||
| --- | |||
|
|
|||
| <-- Does this need to be separate from the [C8 release policy](https://docs.camunda.io/docs/reference/release-policy/)? --> | |||
There was a problem hiding this comment.
[all.hrefProduction] Improper link format: 'C8 release policy'. Please use relative URLs.
There was a problem hiding this comment.
Optimize 8 release policy is aligned with the rest of the stack, so maybe we don't even need this page anymore
|
@toco-cam @RomanJRW, I've done a very quick draft PR to remove Optimize C7 content from Can you remind me how far you want to backport this? We'll also do our best to support redirects to docs.camunda.org, but redirects to a different domain might have unintended SEO consequences or issues. |
optimize/self-managed/optimize-deployment/configuration/security-instructions.md
Show resolved
Hide resolved
| - `SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_JWK_SET_URI` Complete URI to get public keys for JWT validation, e.g. `https://weblogin.cloud.company.com/.well-known/jwks.json`. For more details see [public API authentication](../../apis-tools/optimize-api/optimize-api-authentication.md). | ||
| - `OPTIMIZE_API_ACCESS_TOKEN` secret static shared token to be provided to the secured REST API on access in the authorization header. Will | ||
| be ignored if `SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_JWK_SET_URI` is also set. For more details see [public API | ||
| authentication](../../apis-tools/optimize-api/optimize-api-authentication.md). |
There was a problem hiding this comment.
I think this is C8-related, but might be going away anyway with the Identity changes. @matthewBearCamunda - will this still be relevant going forward?
There was a problem hiding this comment.
It was in a C7 labeled section, but please double check.
| @@ -1,74 +0,0 @@ | |||
| --- | |||
| id: 3.9-to-3.10 | |||
There was a problem hiding this comment.
I think we no longer need the Camunda 8 subfolder, as it will be the only content here after this change
There was a problem hiding this comment.
I'll leave this for now since we still need to rip out the separate instance in the docs for Optimize.
| @@ -4,6 +4,8 @@ title: "Version policy" | |||
| description: "Learn about the versioning policy for Camunda Optimize." | |||
| --- | |||
|
|
|||
| <-- Does this need to be separate from the [C8 release policy](https://docs.camunda.io/docs/reference/release-policy/)? --> | |||
There was a problem hiding this comment.
Optimize 8 release policy is aligned with the rest of the stack, so maybe we don't even need this page anymore
|
@RomanJRW you are too quick! I am working on getting the deploy running. I'll try to add in your feedback, but this is already a great start! |
akeller
added
deploy
optimize/self-managed/optimize-deployment/configuration/system-configuration.md
Show resolved
Hide resolved
optimize/self-managed/optimize-deployment/configuration/clustering.md
Outdated
Show resolved
Hide resolved
|
The preview environment relating to the commit a7b059a has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4785/index.html |
|
|
||
| <span class="badge badge--platform">Camunda 7 only</span> | ||
|
|
||
| ## Overview |
There was a problem hiding this comment.
There is another page here: https://preview.docs.camunda.cloud/pr-4785/optimize/next/self-managed/optimize-deployment/advanced-features/engine-data-deletion/
I think that this is pretty C7 exclusive too (although we never marked it as so). With this in mind, I propose we completely delete the whole "additional features" section from the docs. Wdyt?
| description: "Read about how to configure alert notification webhooks for alerts on custom systems." | ||
| --- | ||
|
|
||
| <span class="badge badge--platform">Camunda 7 only</span> |
There was a problem hiding this comment.
There is a page called "Common problems". I don't think these are a good fit for C8 either, can we delete this too? https://preview.docs.camunda.cloud/pr-4785/optimize/next/self-managed/optimize-deployment/configuration/common-problems/
| The import of object variable values is enabled by default and can be disabled using the `import.data.variable.includeObjectVariableValue` [configuration](./system-configuration-platform-7.md). | ||
| <!-- This section needs attention--> | ||
|
|
||
| The import of object variable values is enabled by default and can be disabled using the `import.data.variable.includeObjectVariableValue` [configuration](#). | ||
|
|
||
| ## Other system configurations | ||
|
|
There was a problem hiding this comment.
There is a tab section below called platformobject - we can delete this too
| @@ -101,7 +95,7 @@ historyCleanup: | |||
|
|
|||
| <TabItem value='ingestedevent'> | |||
There was a problem hiding this comment.
Can we delete this tab item please. This is event based process related, which is not supported in C8 anyway
| @@ -101,7 +95,7 @@ historyCleanup: | |||
|
|
|||
There was a problem hiding this comment.
can't comment in the right place, but we can also delete the decisiondata tab, as this is not supported in C8
| :::note | ||
| The ingested event cleanup does not cascade down to potentially existing [event-based processes](components/userguide/additional-features/event-based-processes.md) that may contain data originating from ingested events. To make sure data of ingested events is also removed from event-based processes, you need to enable the [Process Data Cleanup](#process-data-cleanup) as well. | ||
| The ingested event cleanup does not cascade down to potentially existing [event-based processes](#) that may contain data originating from ingested events. To make sure data of ingested events is also removed from event-based processes, you need to enable the [Process Data Cleanup](#process-data-cleanup) as well. | ||
| ::: | ||
|
|
||
| </TabItem> |
There was a problem hiding this comment.
With the above two tabs removed, we can also greatly simplify the example below to just be:
historyCleanup:
cronTrigger: '0 1 * * 0'
ttl: 'P1Y'
processDataCleanup:
enabled: true
cleanupMode: 'variables'
perProcessDefinitionConfig:
'VeryConfidentProcess':
ttl: 'P1M'
cleanupMode: 'all'
'KeepTwoMonthsProcess':
ttl: 'P2M'
The explanation below can be simplified to correspond to this change too
| | webhookAlerting.webhooks.$\{webhookName}.proxy.host | | The proxy host to use, must be set if webhookAlerting.webhooks.$\{webhookName}.proxy.enabled = true. | | ||
| | webhookAlerting.webhooks.$\{webhookName}.proxy.port | | The proxy port to use, must be set if webhookAlerting.webhooks.$\{webhookName}.proxy.enabled = true. | | ||
| | webhookAlerting.webhooks.$\{webhookName}.proxy.sslEnabled | | Whether this proxy is using a secured connection (HTTPS). Must be set if webhookAlerting.webhooks.$\{webhookName}.proxy.enabled = true. | | ||
|
|
||
| ### History cleanup settings | ||
|
|
||
| Settings for automatic cleanup of historic process/decision instances based on their end time. |
There was a problem hiding this comment.
Also on this page, we can delete the following lines:
- plugin.directory
- plugin.variableImport.basePackages
- plugin.authenticationExtractor.basePackages
- plugin.engineRestFilter.basePackages
- plugin.decisionInputImport.basePackages
- plugin.decisionOutputImport.basePackages
- plugin.elasticsearchCustomHeader.basePackages
- serialization.engineDateFormat
- historyCleanup.ingestedEventCleanup.enabled
- historyCleanup.decisionDataCleanup .perDecisionDefinitionConfig.${key}.ttl
- historyCleanup.decisionDataCleanup.perDecisionDefinitionConfig
- historyCleanup.decisionDataCleanup.enabled
| <span class="badge badge--platform">Camunda 7 only</span> | ||
|
|
||
| To perform an import and provide the full set of features, Optimize requires a connection to the REST API of the Camunda engine. For details on how to configure the connection to the Camunda 7, refer to the [Camunda 7 configuration section](./system-configuration-platform-7.md). | ||
|
|
||
| ## Camunda 8 specific configuration | ||
|
|
||
| For Camunda 8, Optimize is importing process data from exported zeebe records as created by the [Zeebe Elasticsearch Exporter](https://github.com/camunda/camunda/tree/main/zeebe/exporters/elasticsearch-exporter) (or [Zeebe OpenSearch Exporter](https://github.com/camunda/camunda/tree/main/zeebe/exporters/opensearch-exporter)) from the same cluster that Optimize used to store its own data. For the relevant configuration options, refer to the [Camunda 8 import configuration](./system-configuration-platform-8.md). |
There was a problem hiding this comment.
At the bottom of the page, there is a section called "Maximum result limits for queries". This can be deleted completely
| --- | ||
| id: event-ingestion | ||
| title: "Event ingestion" | ||
| description: "The REST API to ingest external events into Optimize." |
There was a problem hiding this comment.
I can still see this page in the sidebar, which I guess needs to be deleted too
|
|
||
| <span class="badge badge--platform">Camunda 7 only</span> | ||
|
|
||
| Occasionally, it is necessary to compare multiple reports or visualize them together in one diagram. This can be achieved by creating a special type of report called a combined process report. To create a new combined process report, visit the **Collections** page and click **Create New > New Report > Combined Process Report**. |
There was a problem hiding this comment.
There is a page in "Additional Features" called "Footer" - https://preview.docs.camunda.cloud/pr-4785/optimize/next/components/userguide/additional-features/footer/
Let's delete that as well, it's not very helpful and is quite C7-centric anyway
Description
First pass at removing C7 content from /next/.
Note - some files from the non-/next/ version were touched due to link issues (mainly the links were pointing to a version outside of their version... which is not ideal for reasons like this). There are a LOT of changes, but let's start with reviewing this set and then backport the changes in separate PRs. To get the build working, some links were replaced with
#.Related to https://github.com/camunda/product-hub/issues/1247.
When should this change go live?
holdlabel or convert to draft PR)PR Checklist
/versioned_docsdirectory./docsdirectory (aka/next/).