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 docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.
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}
|
@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.
There was a problem hiding this comment.
@matthewBearCamunda, can you take a look at this?
There was a problem hiding this comment.
@akeller - I'll figure this out, I'm unsure if this will be going away or not
There was a problem hiding this comment.
All good, to keep the momentum with this PR, I'll leave it for now and can follow up if the rest of the PR looks good to merge. If that happens, I'll turn this into a separate issue and assign it to you @matthewBearCamunda. Thanks!
There was a problem hiding this comment.
@matthewBearCamunda assigned this issue to you, but please feel free to edit the issue so it makes sense to you.
optimize/self-managed/optimize-deployment/migration-update/camunda-7/3.9-to-3.10.md
Show resolved
Hide resolved
|
@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
optimize/components/userguide/additional-features/event-based-processes.md
Show resolved
Hide resolved
optimize/self-managed/optimize-deployment/configuration/object-variables.md
Show resolved
Hide resolved
optimize/self-managed/optimize-deployment/configuration/history-cleanup.md
Outdated
Show resolved
Hide resolved
optimize/self-managed/optimize-deployment/configuration/history-cleanup.md
Outdated
Show resolved
Hide resolved
optimize/self-managed/optimize-deployment/configuration/history-cleanup.md
Outdated
Show resolved
Hide resolved
| | 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
There was a problem hiding this comment.
Oops, there is actually a C8 specific page - system-configuration-platform-8. Is there anything you want to add to that page or can I just remove the C7 one?
There was a problem hiding this comment.
hmm actually taking a second look, there is some things on there that actually apply to C8. This might require a bit more work to determine what the config page should look like. Probably it can all be a single page now, but it might not be as simple as deleting the others without moving over some fields.
A shallow analysis would be to do this:
- rename the C8 config page to something generic
- move over the following properties from the C7 page to the C8 one:
import.skipDataAfterNestedDocLimitReachedimport.elasticsearchJobExecutorThreadCountimport.elasticsearchJobExecutorQueueSize*
- Delete the
Event-based process system configurationpage
There was a problem hiding this comment.
For this exercise, I'm going to leave the pages untouched. Can I create a new issue and assign it to you for further triage with your team?
optimize/self-managed/optimize-deployment/configuration/getting-started.md
Show resolved
Hide resolved
|
@RomanJRW I'll be back to make the changes to this tomorrow. Thank you for your review! |
|
@RomanJRW I've pulled this out of draft because I think we are super close. I do want to acknowledge there will be some broken links, but in order to stay iterative and keep the PRs relatively small, we should accept this for now. That said, if this looks good, I would move quickly on the current version docs so we can setup the appropriate (and functional) redirects. |
|
In the preview env I can still see the plugins pages in the sidebar, this should now be deleted but I can't work out what is missing from this PR. I can also still see the C7 migration and update guide. Am I looking in the right place? https://preview.docs.camunda.cloud/pr-4785/docs/next/self-managed/about-self-managed/ |
It's a me problem -> I need to remove them from the sidebars file. One sec :) |
optimize/self-managed/optimize-deployment/configuration/history-cleanup.md
Outdated
Show resolved
Hide resolved
optimize/self-managed/optimize-deployment/configuration/getting-started.md
Show resolved
Hide resolved
|
@RomanJRW @camunda/tech-writers @pepopowitz after this PR merges, I will follow up with action items (issues) for the discussions in this PR and open separate PRs for each previous version. Let's get the Optimize 7 docs out of there 💪 |
|
The preview environment relating to the commit b661de2 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4785/index.html |
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/).