Skip to content

docs(self-managed): add Opensearch support to elasticsearch prefix indices page #5658

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

drodriguez-305
Copy link
Contributor

Description

related to: camunda/camunda-platform-helm#3378 and camunda/camunda-platform-helm#3379

Adding Opensearch prefix examples and usage.

When should this change go live?

Once this PR is merged.

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and are in the /docs directory (version 8.8).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@drodriguez-305 drodriguez-305 added kind/bug Issues related with bugs in the documentation component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Apr 28, 2025
@drodriguez-305 drodriguez-305 self-assigned this Apr 28, 2025
@drodriguez-305
Copy link
Contributor Author

drodriguez-305 commented Apr 28, 2025

@hisImminence

  • renamed the the markdown files
  • reworded to have a general page for both opensearch and elasticsearch
  • added opensearch examples
  • for 8.5 added a note that Optimize is not supported to work with opensearch

Copy link
Contributor

github-actions bot commented Apr 29, 2025

👋 🤖 🤔 Hello, @drodriguez-305! Did you make your changes in all the right places?

These files were changed only in versioned_docs/version-8.7/. You might want to duplicate these changes in docs/.

  • versioned_docs/version-8.7/self-managed/setup/guides/configure-elastcisearch-prefix-indices.md

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.

@drodriguez-305 drodriguez-305 force-pushed the opensearch-elasticsearch-prefix-indices branch 3 times, most recently from 2776e2d to be4094f Compare April 30, 2025 20:36
@christinaausley
Copy link
Contributor

@drodriguez-305 This builds locally fine, but is timing out on GitHub. We can try a re-run in the morning.

@akeller
Copy link
Member

akeller commented May 1, 2025

Hi Folks - there are typos in the file name that might be causing the weirdness we are seeing with the build. Since it looks like this is present on the main branch, it's indexed with the typo. We'll need to have a redirect with the typo'd URL and correct the file names before merging this PR. Since there is a mismatch in the filename/id, please look at the URLs in this branch and prod to confirm what needs to be in the redirects.

docs/self-managed/setup/guides/configure-elastcisearch-opensearch-prefix-indices.md needs to be docs/self-managed/setup/guides/configure-elasticsearch-opensearch-prefix-indices.md

@drodriguez-305 drodriguez-305 force-pushed the opensearch-elasticsearch-prefix-indices branch 2 times, most recently from db1d268 to 7f42f88 Compare May 1, 2025 15:13
@christinaausley christinaausley requested a review from a team May 1, 2025 19:52
@akeller akeller moved this to 👀 In Review in Documentation Team May 1, 2025
@christinaausley
Copy link
Contributor

christinaausley commented May 1, 2025

So I ran a little test with #5687 -- I changed each of the files and their text only, but GitHub is saying we actually moved the file in next and placed it in the 8.5 docs, and then created a brand new dow for next -- we didn't do this.

I think this is contributing to the wonkiness here, I'm unsure why GitHub is registering that the next file was moved into 8.5, when I only edited the text in each and every file.

@drodriguez-305 drodriguez-305 force-pushed the opensearch-elasticsearch-prefix-indices branch from cca2dc1 to 33e8924 Compare May 1, 2025 23:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed kind/bug Issues related with bugs in the documentation
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

[TASK] Add Dedicated opensearch.prefix Support for Camunda Helm Charts
4 participants