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.

Sign up for GitHub

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

Jump to bottom

docs: update Announcement doc with new Operate and Tasklist webapp urls #4334

Merged
merged 4 commits into from
Oct 1, 2024
Merged

docs: update Announcement doc with new Operate and Tasklist webapp urls #4334

merged 4 commits into from
Oct 1, 2024

Conversation

houssain-barouni
Copy link
Contributor

Description

closes camunda/camunda#20747

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@github-actions GitHub Actions
Copy link
Contributor

👋 🤖 🤔 Hello! 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.5/.

  • docs/reference/announcements.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.

@houssain-barouni houssain-barouni marked this pull request as ready for review September 23, 2024 09:25
@houssain-barouni houssain-barouni added the target:8.6 Issues included in the 8.6 release label Sep 23, 2024
aabouzaid
aabouzaid reviewed Sep 23, 2024
View reviewed changes
docs/reference/announcements.md Outdated

- The new base path for Operate webapp is `/operate`, and for Tasklist webapp, it is `/tasklist`.
- The full URL for Operate webapp will be `{hostname}/operate` or `{hostname}/{operate-contextPath}/operate`, and similarly for Tasklist.
- Any calls to `{hostname}` or `{hostname}/{operate-contextPath}` will automatically be redirected to `{hostname}/operate` or `{hostname}/{operate-contextPath}/operate` respectively, with the same logic applying to Tasklist.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to make it clear that the 1st case works only with Separated Ingress ({hostname} redirects to {hostname}/operate ), and the 2nd case works only with Combined Ingress ({hostname}/operate redirects {hostname}/{operate-contextPath}/operate)

It's also important to know that the Separated Ingress is deprecated in 8.6 and will be removed in 8.7

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did that in this commit ded1842

christinaausley
christinaausley reviewed Sep 23, 2024
View reviewed changes
docs/reference/announcements.md Outdated
@@ -132,6 +132,27 @@ Starting with Camunda 8.6, the Camunda Optimize artifact has been split into two

Make sure to update your Docker configurations accordingly to ensure compatibility.

### New base path for Operate and Tasklist Webapps

We are introducing a new base path for both the Operate and Tasklist **web applications**. This change applies to both self-managed and SaaS environments.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we mean the Operate and Tasklist components?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @christinaausley,
Using “components” might sound too broad. I want to emphasis that this is applicable to the web interfaces urls (Operate and Tasklist UIs) and not to the Operate and Tasklist API urls, so I think "web applications" word is more appropriate.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christinaausley I think we should use "web applications" instead of "components". WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@akeller I feel like we've had a handful of discussion on this, what do you think about this particular instance? CC @camunda/tech-writers

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good spot @christinaausley, but I really like @houssain-barouni's reasoning:

I want to emphasis that this is applicable to the web interfaces urls (Operate and Tasklist UIs) and not to the Operate and Tasklist API urls

A component consists of a UI and an API, but a web app makes sense only when we talk about the UI. Component remains the product/brand name, but at the technical level, it's a web application. Great discussion!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @akeller , I will replace "component" by "web application"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Internal alignment happening here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christinaausley if we can't get alignment next week, let's not consider this blocking. I do want clear definitions, but it shouldn't block merging this.

aabouzaid
aabouzaid previously approved these changes Sep 25, 2024
View reviewed changes
@houssain-barouni houssain-barouni merged commit b06dbf0 into main Oct 1, 2024
8 checks passed
@houssain-barouni houssain-barouni deleted the doc-20747 branch October 1, 2024 11:17
theburi
theburi reviewed Oct 3, 2024
View reviewed changes
docs/reference/announcements.md
@@ -132,6 +132,31 @@ Starting with Camunda 8.6, the Camunda Optimize artifact has been split into two

Make sure to update your Docker configurations accordingly to ensure compatibility.

### New base path for Operate and Tasklist web applications

We are introducing a new base path for both the Operate and Tasklist **web applications**. This change applies to both Self-Managed and SaaS environments.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understanding is that we will move back to the original endpoints in 8.7. We should consider phrasing in a way to indicate this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about "We are currently using a new base path for both the Operate and Tasklist web applications. This change applies to both Self-Managed and SaaS environments." Do we already have an issue open to adjust this for the 8.7 release? I can add one to my docs backlog if not.

Copy link
Contributor Author

@houssain-barouni houssain-barouni Oct 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@theburi I think your are referring to camunda/camunda#23021 (related to https://github.com/camunda/product-hub/issues/2376) ?
I think it will not make it for 8.7.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@theburi theburi theburi left review comments

@christinaausley christinaausley christinaausley approved these changes

@aabouzaid aabouzaid aabouzaid approved these changes

@akeller akeller Awaiting requested review from akeller

@romansmirnov romansmirnov Awaiting requested review from romansmirnov

Assignees

@houssain-barouni houssain-barouni

Labels
target:8.6 Issues included in the 8.6 release
Projects
Developer Experience
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update Announcement doc with new Operate and Tasklist webapp urls
5 participants
@houssain-barouni @akeller @theburi @aabouzaid @christinaausley