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: SAP documentation #4267

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

Conversation

akeller
Copy link
Member

@akeller akeller commented Sep 6, 2024

Description

image

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

github-actions bot commented Sep 6, 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/sap/btp-integration.md
  • docs/components/sap/camunda-sap-integration.md
  • docs/components/sap/img/btp-destination-rfc.png
  • docs/components/sap/img/btp-destination.png
  • docs/components/sap/img/odata-connector-error-expression.png
  • docs/components/sap/img/odata-steps.png
  • docs/components/sap/img/rfc-overview.png
  • docs/components/sap/img/sap-integration-overview.png
  • docs/components/sap/img/sap-odata-connector-element-template-advanced.png
  • docs/components/sap/img/sap-odata-connector-element-template-result.png
  • docs/components/sap/img/sap-odata-connector-element-template.png
  • docs/components/sap/img/sap-odata-connector-task-error-handling1.png
  • docs/components/sap/img/sap-odata-connector-task-error-handling2.png
  • docs/components/sap/img/sap-odata-connector-task-in-model.png
  • docs/components/sap/img/sap-rfc-connector-element-template.png
  • docs/components/sap/img/sap-rfc-connector-task-in-model.png
  • docs/components/sap/odata-connector.md
  • docs/components/sap/rfc-connector.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.

@akeller akeller added hold This issue is parked, do not merge. deploy Stand up a temporary docs site with this PR labels Sep 6, 2024
@akeller
Copy link
Member Author

akeller commented Sep 6, 2024

@vobu here is a docs POC for you to think about where we can place the SAP content.

@github-actions github-actions bot temporarily deployed to camunda-docs September 6, 2024 20:02 Destroyed
@vobu
Copy link

vobu commented Sep 10, 2024

@vobu here is a docs POC for you to think about where we can place the SAP content.

thank you! will add on top of this PR with the SAP Integration documentation.

@github-actions github-actions bot temporarily deployed to camunda-docs September 10, 2024 09:56 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs September 13, 2024 17:42 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs September 15, 2024 20:21 Destroyed
@christinaausley
Copy link
Contributor

@toco-cam Do you have any comments on the layout/formatting of these files? Is there any additional information you are expecting to be added with https://github.com/camunda/product-hub/issues/2415?

@vobu Are you finished adding documentation to this PR? If so, I'll move this out of draft and give it a full review.

@christinaausley christinaausley self-assigned this Sep 19, 2024
@vobu
Copy link

vobu commented Sep 20, 2024

@vobu Are you finished adding documentation to this PR? If so, I'll move this out of draft and give it a full review.

not yet - docs for RFC connector and the BTP Integration are yet to get in there. Will be finished in cw 40 (Oct 4) the latest. Does that still give you enough time to overhaul until CCon NY?

@christinaausley
Copy link
Contributor

@vobu Sounds great! Thanks for the update.

@christinaausley
Copy link
Contributor

Hi @vobu -- just let me know when you are ready for final review here before CCon 👍

@vobu
Copy link

vobu commented Oct 4, 2024

Hi @vobu -- just let me know when you are ready for final review here before CCon 👍

yes, will do as soon as I have more stuff in. Some friendly fire these days, so docs got delayed on my end. Will have finished next week Weg THE LATEST, pinky-promise-swear

@christinaausley
Copy link
Contributor

Hi @vobu -- just let me know when you are ready for final review here before CCon 👍

yes, will do as soon as I have more stuff in. Some friendly fire these days, so docs got delayed on my end. Will have finished next week Weg THE LATEST, pinky-promise-swear

😆 No rush, thanks @vobu!

@akeller akeller removed the deploy Stand up a temporary docs site with this PR label Oct 7, 2024
@akeller
Copy link
Member Author

akeller commented Oct 7, 2024

Removing deploy since it's currently broken. 😢

@akeller akeller added the deploy Stand up a temporary docs site with this PR label Oct 9, 2024
@akeller
Copy link
Member Author

akeller commented Oct 9, 2024

Adding the deploy label back!

Also, thanks for the status updates on this PR.

@github-actions github-actions bot temporarily deployed to camunda-docs October 9, 2024 18:30 Destroyed
docs/guides/sap/rfc-connector.md Outdated Show resolved Hide resolved
docs/guides/sap/rfc-connector.md Outdated Show resolved Hide resolved
docs/guides/sap/odata-connector.md Outdated Show resolved Hide resolved
docs/guides/sap/odata-connector.md Outdated Show resolved Hide resolved
docs/guides/sap/odata-connector.md Outdated Show resolved Hide resolved
docs/guides/sap/odata-connector.md Outdated Show resolved Hide resolved
@christinaausley
Copy link
Contributor

I'll have a look at this today @vobu -- thank you for your effort on this!


> [!IMPORTANT]
>
> The BTP integration is in alpha phase available upon request - please use the https://camunda.com/contact to get in touch.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this an alpha feature, or an experimental feature like RPA? See this PR for context.

@christinaausley
Copy link
Contributor

christinaausley commented Oct 10, 2024

I have cleaned this up as a baseline, and I'm going to give this a second, more in-depth technical review tomorrow, but would be nice to have another @camunda/tech-writers look at this.

Let me know if this is meant to be an experimental feature or an alpha feature, and I'll get this routed to the experimental feature PR and update the sidebar.

@christinaausley christinaausley requested a review from a team October 10, 2024 18:42
@christinaausley christinaausley marked this pull request as ready for review October 10, 2024 18:42
@vobu
Copy link

vobu commented Oct 10, 2024

Thanks for sweeping through!

Let me know if this is meant to be an experimental feature or an alpha feature, and I'll get this routed to the experimental feature PR and update the sidebar.

this is an alpha release, not experimental any more :)
Q1/25 is the targeted-for GA

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

I tried not to get too hands-on with edits here, as this is still in flux, but left some comments that where the instructions/descriptions seemed a little unclear. I'd be happy to look over this to offer a more in-depth review at some point, too; I think my biggest takeaways are breaking down or numbering some of the larger sections for more direct action, and if the term for BTP should be "SAP BTP" throughout.

docs/guides/sap/btp-integration.md Outdated Show resolved Hide resolved
docs/guides/sap/btp-integration.md Outdated Show resolved Hide resolved
docs/guides/sap/camunda-sap-integration.md Outdated Show resolved Hide resolved
docs/guides/sap/camunda-sap-integration.md Outdated Show resolved Hide resolved
docs/guides/sap/odata-connector.md Outdated Show resolved Hide resolved
docs/guides/sap/odata-connector.md Outdated Show resolved Hide resolved
docs/guides/sap/odata-connector.md Outdated Show resolved Hide resolved
docs/guides/sap/odata-connector.md Outdated Show resolved Hide resolved
docs/guides/sap/rfc-connector.md Outdated Show resolved Hide resolved
@akeller
Copy link
Member Author

akeller commented Oct 10, 2024

@christinaausley please rename this PR if you are moving forward with it. The branch name is fine, but the PR title "POC: SAP guides" isn't intuitive enough.

@christinaausley christinaausley changed the title POC: SAP guides experimental: SAP documentation Oct 10, 2024
@christinaausley christinaausley changed the base branch from main to experimental-structure-PR October 10, 2024 22:23
@@ -0,0 +1,170 @@
---
id: odata-connector
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link

Choose a reason for hiding this comment

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

yes - but they need to be run in "hybrid" mode, on the SAP BTP of the customer. We don't run them in SaaS or on any SM k8s

Copy link
Contributor

Choose a reason for hiding this comment

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

Note to myself to add something on this once merged into the main PR and I can properly route to these links.

@christinaausley
Copy link
Contributor

christinaausley commented Oct 11, 2024

Hi all -- this is ready for a final approval to merge into the experimental structure PR, which will also get a final approval before going into main. Note that this will not build clean until it is merged in, and I can properly structure things in the sidebar 👍

Copy link
Contributor

🚧 The preview environment for the commit ba10a63 is being built. This usually takes 15-20 minutes.

@christinaausley christinaausley removed the hold This issue is parked, do not merge. label Oct 11, 2024
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 Progress
Development

Successfully merging this pull request may close these issues.

4 participants