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(operate): add section: monitor operation status #4104

Merged
merged 7 commits into from
Aug 8, 2024
Merged

docs(operate): add section: monitor operation status #4104

merged 7 commits into from
Aug 8, 2024

Conversation

pedesen
Copy link
Contributor

@pedesen pedesen commented Aug 5, 2024 •
edited
Loading

Description

  • add new section to Operate user guide: monitor operation status
  • add links to that section in the following sections:
    • Selections and operations
    • Process instance migration
    • Process instance modification
    • Process instance batch modification

closes #3654

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

github-actions bot commented Aug 5, 2024

👋 🤖 🤔 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/components/operate/userguide/img/monitor-operation-state/expand-row-button.png
  • docs/components/operate/userguide/img/monitor-operation-state/expanded-instances-row.png
  • docs/components/operate/userguide/img/monitor-operation-state/expanded-operations-panel.png
  • docs/components/operate/userguide/img/monitor-operation-state/operation-state-row.png
  • docs/components/operate/userguide/img/monitor-operation-state/operations-panel.png
  • docs/components/operate/userguide/monitor-operation-status.md
  • docs/components/operate/userguide/process-instance-batch-modification.md
  • docs/components/operate/userguide/process-instance-migration.md
  • docs/components/operate/userguide/process-instance-modification.md
  • docs/components/operate/userguide/selections-operations.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.

@pedesen pedesen requested a review from a team August 5, 2024 13:41
@pedesen pedesen marked this pull request as ready for review August 5, 2024 13:41
@christinaausley christinaausley added component:operate Issues related with Operate project target:8.6 Issues included in the 8.6 release labels Aug 5, 2024
@christinaausley
Copy link
Contributor

@pedesen Would you like this to go out with the alpha next week?

@pedesen
Copy link
Contributor Author

pedesen commented Aug 5, 2024

@christinaausley would be nice, if that's possible.

@christinaausley christinaausley added 8.6.0-alpha4 August 2024 alpha release and removed target:8.6 Issues included in the 8.6 release labels Aug 5, 2024
christinaausley
christinaausley reviewed Aug 6, 2024
View reviewed changes
docs/components/operate/userguide/monitor-operation-status.md Outdated

![operate-view-process-filters](./img/monitor-operation-state/operations-panel.png)

Select an operation from the list by clicking on the operation id. Notice that the operation if is set as a filter:
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add a note in the case the user doesn't have any operations and sees "No operations have been created yet."?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea, I added it.

@pedesen pedesen requested a review from christinaausley August 7, 2024 08:01
@pedesen pedesen merged commit 49820bc into main Aug 8, 2024
7 checks passed
@pedesen pedesen deleted the 3654-operate-monitor-operations-status branch August 8, 2024 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christinaausley christinaausley christinaausley approved these changes

Assignees

@pedesen pedesen

Labels
8.6.0-alpha4 August 2024 alpha release component:operate Issues related with Operate project
Projects
Developer Experience
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document how to monitor operation status in Operate user guide
2 participants
@pedesen @christinaausley