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

add nodejs sdk to overview page #4784

Merged
merged 6 commits into from
Dec 18, 2024
Merged

Conversation

christinaausley
Copy link
Contributor

Description

Closes #4782.

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

@christinaausley christinaausley added component:docs Documentation improvements, including new or updated content deploy Stand up a temporary docs site with this PR labels Dec 17, 2024
@christinaausley christinaausley requested a review from a team December 17, 2024 15:06
@christinaausley christinaausley self-assigned this Dec 17, 2024
mesellings
mesellings previously approved these changes Dec 17, 2024
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Lgtm 👍 🚀

One non-blocking issue that perhaps is just something to look at when we move to docusaurus 3 is that the card height is dependent on the text content - here the node card is now taller than the one next to it:

image

I would expect card components to behave slightly differently ideally, but I guess our options are:

  1. Adjust the meta description for the node.js page, i.e. remove ", available via npm.", except this then conflicts with SEO description length.
  2. Leave as is, take a look at card components in Docusaurus 3.

I guess we shouldn't be trying to fit content to a responsive layout, so I think 2 is our best option, but up to you - just something I noticed?

@christinaausley
Copy link
Contributor Author

@mesellings Good catch. This was bothering me so for the time being I adjusted the description length, as it isn't dire either way. Cheers to Doc3 when this perhaps won't be an issue?

@github-actions github-actions bot temporarily deployed to camunda-docs December 17, 2024 21:04 Destroyed
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Lgtm 👍 🚀

@christinaausley christinaausley merged commit 6a61a11 into main Dec 18, 2024
8 checks passed
@christinaausley christinaausley deleted the add-node-sdk-to-overview branch December 18, 2024 16:07
Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content deploy Stand up a temporary docs site with this PR
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Add Node SDK to SDK section
3 participants