Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecated config default docs link points to C8 docs #4782

Closed
4 tasks done
Tracked by #4716
PHWaechtler opened this issue Nov 11, 2024 · 5 comments
Closed
4 tasks done
Tracked by #4716

Deprecated config default docs link points to C8 docs #4782

PHWaechtler opened this issue Nov 11, 2024 · 5 comments
Assignees
Labels
scope:documentation Changes to the product documentation. scope:optimize Changes to Optimize. type:task Issues that are a change to the project that is neither a feature nor a bug fix. version:optimize 3.14.2 version:optimize 3.15.0

Comments

@PHWaechtler
Copy link
Contributor

PHWaechtler commented Nov 11, 2024

Context

Currently, the default docs URL in Optimizes ConfigurationValidator points to https://docs.camunda.io/optimize/next/self-managed/optimize-deployment/configuration/system-configuration/. Example shared in the Hints.
We should consider whether this is still correct now that Optimize 7 docs have been moved. However, its possible that some of the referenced deprecated config locations may not exist in Optimize 7 docs.
I also suspect some of the paths are no longer accurate.

Acceptance Criteria (Required on creation)

  • Optimize 7 docs are linked where possible in the source code.

Hints

Links

Breakdown

Pull Requests

Preview Give feedback

Dev2QA handover

  • Does this ticket need a QA test and the testing goals are not clear from the description? Add a Dev2QA handover comment
@PHWaechtler PHWaechtler added type:task Issues that are a change to the project that is neither a feature nor a bug fix. scope:optimize Changes to Optimize. labels Nov 11, 2024
@yanavasileva
Copy link
Member

Sending for a decision
@tasso94, could you please prioritize this ticket.
Impact is only for developers, it is not user facing. Can be done as a follow up of #4716.

@mboskamp
Copy link
Member

CI failures are known flaky tests.
The review of this ticket is low-prio.

@mboskamp mboskamp assigned PHWaechtler and unassigned mboskamp Dec 11, 2024
@PHWaechtler PHWaechtler assigned mboskamp and unassigned PHWaechtler Dec 12, 2024
@PHWaechtler
Copy link
Contributor Author

@mboskamp Fyi this PR is about to make a small change to a file you're also touching so there might be conflicts. The other PR is just adding one line though

@mboskamp mboskamp added scope:documentation Changes to the product documentation. version:optimize 3.14.2 and removed potential:optimize 3.14.2 labels Jan 6, 2025
@mboskamp mboskamp closed this as completed Jan 6, 2025
@mboskamp mboskamp reopened this Jan 6, 2025
@mboskamp
Copy link
Member

mboskamp commented Jan 6, 2025

Reopen because of CI failure.
Related CI failure: https://github.com/camunda/camunda-optimize/actions/runs/12630338505/job/35190724399

<   "org.opencontainers.image.documentation": "https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/",
---
>   "org.opencontainers.image.documentation": "https://docs.camunda.io/docs/self-managed/optimize-deployment/install-and-start/",
18c18
<   "org.opencontainers.image.url": "https://docs.camunda.org/optimize/",
---
>   "org.opencontainers.image.url": "https://docs.camunda.io/docs/components/optimize/what-is-optimize/",
Expected label values (marked by '<') do not match actual label values (marked by '>'); if you think this is wrong, update the golden file at ./optimize/docker/test/docker-labels.golden.json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:documentation Changes to the product documentation. scope:optimize Changes to Optimize. type:task Issues that are a change to the project that is neither a feature nor a bug fix. version:optimize 3.14.2 version:optimize 3.15.0
Projects
None yet
Development

No branches or pull requests

4 participants