feat: add RPA getting started guide #5186
Conversation
|
👋 🤖 🤔 Hello, @christinaausley! 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/.
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. |
docs/components/RPA/production.md
Outdated
| This article covers the specific configuration of your RPA runner. For the basic getting started guide, check the | ||
| [getting started guide](./getting-started.md). | ||
|
|
||
| ## Using Secrets |
There was a problem hiding this comment.
Secrets are disabled by default, and are enabled by configuring the property camunda.rpa.zeebe.secrets.secrets-endpoint (the Worker has no way of determining this).
It doesn't apply to the prod SaaS environment (and therefore might not be worth mentioning), but the default value for camunda.rpa.zeebe.secrets.token-audience only works for prod, and must be configured for the dev instances.
There was a problem hiding this comment.
The Console secrets endpoint for C8-SaaS is https://cluster-api.cloud.camunda.io/secrets, why not have this as the default?
With the default and graceful failure, we could enable secrets by default. Alternatively, consider Secrets being a Boolean toggle, similar to enabling zeebe. This makes it explicit to the user what implications the Config option has
There was a problem hiding this comment.
I'd like to avoid exposing the cluster-api.cloud.camunda.io endpoint to the users, as the console API is internal and not publicly documented
There was a problem hiding this comment.
I added the config option in 321d9d5 for now
|
Awesome @marstamm! I will get this reviewed today. Is this something that can go out with the alpha next week, or is removing it from the early access section reserved for the minor? If that's the case, we could always get the getting started guide merged in for the alpha and remove early access in a separate PR for the minor. |
|
Note to self that I will need to add redirects. |
|
@marstamm -- This looks like it has undergone initial review. Would you like this to go out tomorrow? I can review, remove the old pages, and get it merged before the end of the day. If this sounds good to you, can you put together a few brief sentences for the release notes? |
|
Thank you @christinaausley , this sounds good! I'll have the release notes ready by EOD. My afternoon is a bit packed so I can't promise it any sooner, but I'll try to squeeze it in 😄 |
docs/components/early-access/experimental/rpa/rpa-integration-with-camunda.md
Show resolved
Hide resolved
|
This is ready for final review -- I'll have one more look over it this afternoon and merge. @mattli2024 Not sure if you want to have a look? Thanks all for your efforts! |
|
🧹 Preview environment for this PR has been torn down. |
Description
This PR adds RPA getting started guides. It is currently a Draft PR to get feedback on structure and wording. I will migrate the changes to the 8.7 version as well once we feedback on the content.
related to https://github.com/camunda/product-hub/issues/2533
When should this change go live?
bugorsupportlabel)available & undocumentedlabel)holdlabel)low priolabel)PR Checklist
/docsdirectory (version 8.8)./versioned_docs/version-8.7/directory (version 8.7)./versioned_docsdirectory.@camunda/tech-writersunless working with an embedded writer.