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

docs: update spring Zeebe guide #4067

Merged
merged 7 commits into from
Jul 29, 2024
Merged

Conversation

pepopowitz
Copy link
Collaborator

Description

I recently recorded a walkthrough of the Spring Zeebe guide, and while doing so, noticed a few things that could be specified more precisely.

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/).

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/guides/react-components/install-plain-java.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.

@@ -81,7 +81,7 @@ To deploy your process, take the following steps:
3. Change the **Cluster endpoint** to `http://localhost:26500/`, with no authentication.
4. Click **Deploy**.

When you open Operate at http://localhost:8081/, you should now note the process deployed to your local Self-Managed setup.
When you open Operate at http://localhost:8080/operate/, you should now note the process deployed to your local Self-Managed setup.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This URL changed when we switched to the plain-java installation.

Note that I've only added this change to vNext, because vCurrent still uses the docker-compose installation method.

Copy link
Member

Choose a reason for hiding this comment

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

We would also need to change the tip admonition in Step 1, but it currently states that Operate can be found at localhost:8080 (which redirects to 8080/operate/).

Copy link
Member

Choose a reason for hiding this comment

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

I said this poorly - I just expect them to match. Whether they use redirects or not, I don't care.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'll get them aligned.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

aligned in latest commit.

Comment on lines +185 to +199

```java
package io.camunda.demo.process_payments;

import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

import io.camunda.zeebe.client.ZeebeClient;
import io.camunda.zeebe.spring.client.annotation.Deployment;
```
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I lost an embarrassing amount of time trying to track down the most basic of imports (java.util.Map). We specify the imports in the previous code-heavy step; specifying them here could save someone like me from import-hunting.

@@ -22,7 +22,7 @@ Confirm Elasticsearch is running by visiting `http://localhost:9200` in a browse

### Download and configure Camunda

1. Download the [latest release artifact](https://github.com/camunda/camunda/releases) in the **Assets** section of the release page, starting with [8.6.0-alpha2](https://github.com/camunda/camunda/releases/tag/8.6.0-alpha2).
1. Download and extract the [latest `camunda-zeebe-` release artifact](https://github.com/camunda/camunda/releases) in the **Assets** section of the release page, starting with [8.6.0-alpha2](https://github.com/camunda/camunda/releases/tag/8.6.0-alpha2).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Note that this change is only added in vNext, because vCurrent uses the docker-compose installation method (nothing to extract).

@pepopowitz pepopowitz self-assigned this Jul 25, 2024
@pepopowitz pepopowitz added the component:docs Documentation improvements, including new or updated content label Jul 25, 2024
@christinaausley
Copy link
Contributor

Nice. Thanks @pepopowitz!

@christinaausley christinaausley mentioned this pull request Jul 26, 2024
9 tasks
@pepopowitz pepopowitz merged commit 1759bee into main Jul 29, 2024
7 checks passed
@pepopowitz pepopowitz deleted the pepopowitz/spring-guide-updates branch July 29, 2024 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants