Skip to content

Connector casing (wave 1 - connectors) #5702

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

Merged
merged 6 commits into from
May 7, 2025
Merged

Connector casing (wave 1 - connectors) #5702

merged 6 commits into from
May 7, 2025

Conversation

mesellings
Copy link
Contributor

Description

This PR begins tackling the monumental task of changing Connector > connector casing throughout the docs.

See https://github.com/camunda/documentation-team/issues/429.

For example, Email Connector > Email connector.

Due to the size of this change, this PR only focuses on:

  • The Connectors section itself, with content outside of this to follow in a separate PR.
  • 8.7 and 8.8 docs.

Follow-up PRs will tackle casing outside of the Connectors section - there are many thousands of instances, all of which probably need some manual checking.

Gotchas

Changing this word/case has to be done carefully, here is the method I used

  1. Initially, run find & replace: Connector > connector in each file.
  2. Manually scan/check for headings, code, components, and sidebar entries that need to be ignored/not included in the replace operation.
  3. After completion, search files for # connector to check for any erroneous headings.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and are in the /docs directory (version 8.8).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@mesellings mesellings added the available & undocumented This is already available but undocumented and should be released within a week. label May 2, 2025
@mesellings mesellings requested review from YanaSegal and a team May 2, 2025 11:19
@mesellings mesellings self-assigned this May 2, 2025
@akeller akeller moved this to 👀 In Review in Documentation Team May 2, 2025
Copy link
Contributor

github-actions bot commented May 2, 2025

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

  • docs/components/connectors/custom-built-connectors/build-connector.md
  • docs/components/connectors/introduction.md
  • docs/components/connectors/out-of-the-box-connectors/hubspot.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[bot]

This comment was marked as resolved.

@mesellings mesellings added the component:connectors Issues related to the connectors project. label May 2, 2025
@mesellings
Copy link
Contributor Author

FYI @YanaSegal 👍

@mesellings mesellings removed the request for review from YanaSegal May 2, 2025 11:24
@mesellings mesellings changed the title Connector casing (wave 1) Connector casing (wave 1 - connectors) May 2, 2025
@mesellings mesellings added the component:docs Documentation improvements, including new or updated content label May 2, 2025
akeller
akeller previously approved these changes May 2, 2025
Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

I did a spot check here based on the changes, and this looks great.

I found one unrelated typo, which you can choose to address in this PR or separately (I'm assuming it's across multiple versions 🥲 ).

@mesellings
Copy link
Contributor Author

I did a spot check here based on the changes, and this looks great.

I found one unrelated typo, which you can choose to address in this PR or separately (I'm assuming it's across multiple versions 🥲 ).

Thanks @akeller - please can I get another approval - I fixed the typo across versions in this PR, as I had to fix a merge conflict caused by an update to a connector doc - thank you! 🙏

@mesellings mesellings merged commit 85f4291 into main May 7, 2025
9 checks passed
@mesellings mesellings deleted the connector-casing branch May 7, 2025 07:33
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in Documentation Team May 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
available & undocumented This is already available but undocumented and should be released within a week. component:connectors Issues related to the connectors project. component:docs Documentation improvements, including new or updated content
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants