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

docs(sql-connector): Add the documentation for the new SQL Connector #3707

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

johnBgood
Copy link
Contributor

@johnBgood johnBgood commented Apr 23, 2024

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

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions
  • 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.
  • 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.

@johnBgood johnBgood added component:connectors Issues related to the connectors project. 8.6.0-alpha1 May 2024 alpha release labels Apr 23, 2024
@johnBgood johnBgood self-assigned this Apr 23, 2024
Copy link
Contributor

👋 🤖 🤔 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.

Copy link
Contributor

@YanaSegal YanaSegal left a comment

Choose a reason for hiding this comment

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

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/

@johnBgood
Copy link
Contributor Author

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 ?

@christinaausley
Copy link
Contributor

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 👍

Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

Will this still be backported all the way through the docs, and just merged/released closer to the release date?

@johnBgood
Copy link
Contributor Author

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 :)

YanaSegal
YanaSegal previously approved these changes Apr 25, 2024
christinaausley
christinaausley previously approved these changes May 3, 2024
@christinaausley
Copy link
Contributor

christinaausley commented May 13, 2024

@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 johnBgood added 8.6.0-alpha2 and removed 8.6.0-alpha1 May 2024 alpha release labels May 13, 2024
@johnBgood
Copy link
Contributor Author

johnBgood commented May 13, 2024

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.6.0-alpha2 component:connectors Issues related to the connectors project.
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

None yet

3 participants