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

experimental: RPA documentation #4440

Open
wants to merge 10 commits into
base: experimental-structure-PR
Choose a base branch
from

Conversation

christinaausley
Copy link
Contributor

@christinaausley christinaausley commented Oct 9, 2024

Description

Relates to https://github.com/camunda/product-hub/issues/2412.

Incorporates RPA documentation into experimental features.

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

@christinaausley christinaausley added the hold This issue is parked, do not merge. label Oct 9, 2024
@christinaausley christinaausley self-assigned this Oct 9, 2024
Copy link
Contributor

github-actions bot commented Oct 9, 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.6/.

  • docs/components/experimental/feature1.md
  • docs/components/experimental/feature2.md
  • docs/components/experimental/img/rpa-task-example.png
  • docs/components/experimental/img/testing-rpa.png
  • docs/components/experimental/rpa/camunda-rpa-framework-library.md
  • docs/components/experimental/rpa/rpa-integration-with-camunda.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.

@christinaausley christinaausley marked this pull request as ready for review October 10, 2024 17:21
@christinaausley
Copy link
Contributor Author

@marstamm Is this meant to go into the 8.6 docs as well, or is this only for the next docs?

@christinaausley christinaausley added the deploy Stand up a temporary docs site with this PR label Oct 10, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs October 10, 2024 17:56 Destroyed
@christinaausley christinaausley changed the title add rpa documentation experimental: RPA documentation Oct 10, 2024
Copy link
Member

@nikku nikku left a comment

Choose a reason for hiding this comment

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

Feedback on the addition (some meta-feedback inside) ⏬


Add relevant links (i.e. link to the components from the description for easier access):

image


Do not make the "Robottic Process Automation" navigation entry a dead link. Instead, as I click on it I end up on the page describing it. Remove on of the sub-pages. Consider to call the page "RPA integration" (it should be clear that this is with Camunda).

See Desktop Modeler and some other pages that already have a proper navigation structure (where clicking a section leads to actual content, not just opens it in the navigation):

capture CuwD0P_optimized


This does not seem to be properly formatted (the numbered list is part of the second bullet point):

image


Borders / padding around screenshots look odd, remove them:

image


Consider to link back to the "landing page" for RPA, to provide further context from the RPA framework library page:

image


Does not make sense to me:

image


I propose we make {variableName} verbatime (code) syntax here, as it references a technical idenfifier (in the above script):

image

@github-actions github-actions bot temporarily deployed to camunda-docs October 11, 2024 13:15 Destroyed
Copy link
Member

@marstamm marstamm left a comment

Choose a reason for hiding this comment

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

Added a few comments with small improvements, nothing major from my side :)

@christinaausley christinaausley requested a review from a team October 11, 2024 16:10
@christinaausley
Copy link
Contributor Author

I have resolved all lingering comments @marstamm -- let me know how this looks to you 👍

@christinaausley christinaausley removed the hold This issue is parked, do not merge. label Oct 11, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs October 11, 2024 16:29 Destroyed
Copy link
Contributor

The preview environment relating to the commit c86c0a1 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4440/index.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Stand up a temporary docs site with this PR
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

3 participants