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

Connectors wave 1 #4794

Draft
wants to merge 37 commits into
base: main
Choose a base branch
from
Draft

Connectors wave 1 #4794

wants to merge 37 commits into from

Conversation

mesellings
Copy link
Contributor

@mesellings mesellings commented Dec 19, 2024

Description

DO NOT MERGE

This is the draft for the first wave of the Connector docs enhancements.

See https://github.com/camunda/developer-experience/issues/356.

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

@mesellings mesellings added kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) component:docs Documentation improvements, including new or updated content hold This issue is parked, do not merge. component:connectors Issues related to the connectors project. target:8.7 Issues included in the 8.7 release deploy Stand up a temporary docs site with this PR labels Dec 19, 2024
@mesellings mesellings self-assigned this Dec 19, 2024
Copy link
Contributor

github-actions bot commented Dec 19, 2024

👋 🤖 🤔 Hello, @mesellings! 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/connectors/connector-types.md
  • docs/components/connectors/custom-built-connectors/build-connector.md
  • docs/components/connectors/custom-built-connectors/connector-template-generator.md
  • docs/components/connectors/custom-built-connectors/img/diagram-connectors.png
  • docs/components/connectors/img/Untitled-1.png
  • docs/components/connectors/img/connector-365.png
  • docs/components/connectors/img/connector-amazon-bedrock.png
  • docs/components/connectors/img/connector-amazon-eventbridge.png
  • docs/components/connectors/img/connector-amazon-sns.png
  • docs/components/connectors/img/connector-amazon-sqs.png
  • docs/components/connectors/img/connector-asana.png
  • docs/components/connectors/img/connector-automation.png
  • docs/components/connectors/img/connector-aws-dynamodb.png
  • docs/components/connectors/img/connector-aws-lambda.png
  • docs/components/connectors/img/connector-azure-openai.png
  • docs/components/connectors/img/connector-blueprism.png
  • docs/components/connectors/img/connector-camunda.png
  • docs/components/connectors/img/connector-easypost.png
  • docs/components/connectors/img/connector-email.png
  • docs/components/connectors/img/connector-github.png
  • docs/components/connectors/img/connector-gitlab.png
  • docs/components/connectors/img/connector-google-drive.png
  • docs/components/connectors/img/connector-google-maps.png
  • docs/components/connectors/img/connector-google-sheets.png
  • docs/components/connectors/img/connector-graphql.png
  • docs/components/connectors/img/connector-hugging-face.png
  • docs/components/connectors/img/connector-kafka.png
  • docs/components/connectors/img/connector-openai.png
  • docs/components/connectors/img/connector-overview.png
  • docs/components/connectors/img/connector-rabbitmq.png
  • docs/components/connectors/img/connector-rest.png
  • docs/components/connectors/img/connector-salesforce.png
  • docs/components/connectors/img/connector-sendgrid.png
  • docs/components/connectors/img/connector-slack.png
  • docs/components/connectors/img/connector-soap.png
  • docs/components/connectors/img/connector-sql.png
  • docs/components/connectors/img/connector-teams.png
  • docs/components/connectors/img/connector-twilio.png
  • docs/components/connectors/img/connector-uipath.png
  • docs/components/connectors/img/connector-webhook.png
  • docs/components/connectors/img/connector-whatsapp.png
  • docs/components/connectors/img/icon-connector-custom.png
  • docs/components/connectors/img/icon-connector-sdk.png
  • docs/components/connectors/img/icon-connector-template.png
  • docs/components/connectors/img/icon-connector-types.png
  • docs/components/connectors/img/icon-connectors.png
  • docs/components/connectors/img/icon-marketplace.png
  • docs/components/connectors/img/icon-play.png
  • docs/components/connectors/introduction.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-bedrock.md
  • docs/components/connectors/out-of-the-box-connectors/asana.md
  • docs/components/connectors/out-of-the-box-connectors/automation-anywhere.md
  • docs/components/connectors/out-of-the-box-connectors/available-connectors-overview.md
  • docs/components/connectors/out-of-the-box-connectors/blueprism.md
  • docs/components/connectors/out-of-the-box-connectors/connectors-table.css
  • docs/components/connectors/out-of-the-box-connectors/connectors-table.js
  • docs/components/connectors/out-of-the-box-connectors/easy-post.md
  • docs/components/connectors/out-of-the-box-connectors/email.md
  • docs/components/connectors/out-of-the-box-connectors/github.md
  • docs/components/connectors/out-of-the-box-connectors/gitlab.md
  • docs/components/connectors/out-of-the-box-connectors/google-gemini.md
  • docs/components/connectors/out-of-the-box-connectors/google-maps-platform.md
  • docs/components/connectors/out-of-the-box-connectors/google-sheets.md
  • docs/components/connectors/out-of-the-box-connectors/googledrive.md
  • docs/components/connectors/out-of-the-box-connectors/hugging-face.md
  • docs/components/connectors/out-of-the-box-connectors/kafka.md
  • docs/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md
  • docs/components/connectors/out-of-the-box-connectors/microsoft-teams.md
  • docs/components/connectors/out-of-the-box-connectors/openai.md
  • docs/components/connectors/out-of-the-box-connectors/operate.md
  • docs/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md
  • docs/components/connectors/out-of-the-box-connectors/salesforce.md
  • docs/components/connectors/out-of-the-box-connectors/sendgrid.md
  • docs/components/connectors/out-of-the-box-connectors/slack.md
  • docs/components/connectors/out-of-the-box-connectors/sql.md
  • docs/components/connectors/out-of-the-box-connectors/twilio.md
  • docs/components/connectors/out-of-the-box-connectors/uipath.md
  • docs/components/connectors/out-of-the-box-connectors/whatsapp.md
  • docs/components/connectors/protocol/graphql.md
  • docs/components/connectors/protocol/http-webhook.md
  • docs/components/connectors/protocol/polling.md
  • docs/components/connectors/protocol/rest.md
  • docs/components/connectors/protocol/soap.md
  • docs/components/connectors/react-components/_banner-marketplace.md
  • docs/components/connectors/react-components/icon-marketplace.png
  • docs/components/connectors/use-connectors/inbound.md
  • docs/components/connectors/use-connectors/index.md
  • docs/components/connectors/use-connectors/outbound.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.

@github-actions github-actions bot temporarily deployed to camunda-docs December 20, 2024 15:31 Destroyed
Copy link
Contributor

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

@mesellings
Copy link
Contributor Author

@sbuettner Although still a WIP, I managed to spend a few days this week on the connectors wave 1 work (I've had to bring some of the landing page work in as well).

You can preview this at:

https://preview.docs.camunda.cloud/pr-4794/docs/next/components/connectors/introduction-to-connectors/

  • You can see the content is now structured into 3 areas, should be much clearer and quicker for users to find content.
  • I added a popular/new section to the landing page - wdyt?
  • Added a banner to cross-link to the marketplace.
  • On the main Connectors page I changed the layout to match the home page tiles, and used clickable badges instead of a dropdown for a better UX.
  • I've added connector logos and used marketplace/product ones where possible, but some don't lend themselves well to our content (tiny text) so some are different. I can work with @YanaSegal on these.
  • I removed the "connector" suffix from the left-hand menu items, much clearer now.
  • I still have to look at the custom connectors landing page, that would be my next job.
  • This work gives us a restructured menu etc, and improves the main landing pages, which would leave the template and individual pages to tackle in separate PRs for waves 2 and 3 (@christinaausley and I will tackle this).
  • I have started making "Connector" lower-case as part of the Connector casing work.

I wouldn't do a review yet until it is ready, but I just wanted to update you on some good progress - we should be able to get this out in January sometime. 🤞

FYI: @akeller @crobbins215

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:connectors Issues related to the connectors project. component:docs Documentation improvements, including new or updated content deploy Stand up a temporary docs site with this PR hold This issue is parked, do not merge. kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) target:8.7 Issues included in the 8.7 release
Projects
Status: 🏗 In Progress
Development

Successfully merging this pull request may close these issues.

1 participant