camunda-docs
camunda-docs copied to clipboard
docs(sql-connector): Add the documentation for the new SQL Connector
Description
Documentation for the new SQL (outbound) connector.
Note: these changes will be introduced with 8.6-alpha2.
Product hub Epic here. Implementation PR here.
When should this change go live?
- [ ] This change is not yet live and should not be merged until {ADD_DATE} (apply
hold
label or convert to draft PR)? - [ ] There is no urgency with this change.
- [ ] This change or page is part of a marketing blog, conference talk, or something else on a schedule.
- [ ] This functionality is already available but undocumented.
- [ ] This is a bug fix or security concern.
PR Checklist
- [x] ~~I have added changes to the relevant
/versioned_docs
directory, or~~ they are not for an already released version. - [x] I have added changes to the main
/docs
directory (aka/next/
)~~, or they are not for future versions~~ - [x] My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
- [x] My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.
:wave: :robot: :thinking: 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/connectors/out-of-the-box-connectors/available-connectors-overview.md
- docs/components/connectors/out-of-the-box-connectors/sql.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.
Create a SQL Connector task To use the SQL Connector in your process, either change the type of existing task by clicking on it and using the wrench-shaped Change type context menu icon or create a new Connector task by using the Append Connector context menu....
we have a new context pad and the wrench icon doesn't exist there. and the link to "follow our guide..." is not explaining about applying a connector to a diagram. Maybe this link will be better to point to: http://localhost:3000/docs/next/components/modeler/web-modeler/new-context-pad/
I think that this context pad is an alpha feature, and we still have the wrench in the Desktop modeler. Moreover, all our OOTB connectors documentations have this section. What I suggest is to create a ticket to update all our docs at once, when this feature is not alpha anymore. What do you think @YanaSegal ?
I think that this context pad is an alpha feature, and we still have the wrench in the Desktop modeler. Moreover, all our OOTB connectors documentations have this section. What I suggest is to create a ticket to update all our docs at once, when this feature is not alpha anymore.
Yeah, we'll need to update this if the UI has changed. A separate issue would be great 👍
Will this still be backported all the way through the docs, and just merged/released closer to the release date?
It's not backported; Will need to be merged closer to the release data indeed :)
@johnBgood Are you looking for a final review here before merging for release tomorrow, or are there additional changes you are planning to make?
@johnBgood Are you looking for a final review here before merging for release tomorrow, or are there additional changes you are planning to make?
@christinaausley I updated the label, due to some random issues last week we decided to release this feature next month. So we can keep this PR open until then if that's ok.