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 inline-image style for BPMN icon images #4647

Merged
merged 2 commits into from
Nov 26, 2024
Merged

Conversation

mesellings
Copy link
Contributor

Description

Closes #4629.

This is a quick fix that applies an inline style to these BPMN icon images to at least make them smaller and remove borders, padding, and so on.

However, some of these icons already have vertical spacing within the SVG, and we shouldn't changes these icons without understanding the impact on wherever else these are used in the docs. As a result, the gateway icon does not 'sit' on the baseline.

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/bug Issues related with bugs in the documentation component:docs Documentation improvements, including new or updated content deploy Stand up a temporary docs site with this PR labels Nov 22, 2024
@mesellings mesellings requested a review from akeller November 22, 2024 17:29
@mesellings mesellings self-assigned this Nov 22, 2024
Copy link
Contributor

👋 🤖 🤔 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/best-practices/modeling/creating-readable-process-models.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 November 22, 2024 17:47 Destroyed
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.

The BPMN diagrams from BPMN.io and the icons don't seem to want to load at all in the preview environment, so I'll pull this down and run it locally.

Related, the BPMN diagrams from BPMN.io load slow on production.

akeller
akeller previously approved these changes Nov 22, 2024
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.

Looks good when running locally! Thank you!

BTW, I saw you removed "like" from the sentence. I think this is trying to communicate that it's an example gateway symbol as there are multiple.

@mesellings
Copy link
Contributor Author

Hi @camunda/tech-writers please can I get an approval as Amara is away this week? I just added the word "such as" back in after prior approval.

@github-actions github-actions bot temporarily deployed to camunda-docs November 24, 2024 14:34 Destroyed
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

No idea why these don't build in the preview, but the images do look great locally -thanks for this fix!

@mesellings mesellings merged commit a9db86f into main Nov 26, 2024
8 checks passed
@mesellings mesellings deleted the bpmn-inline-image-size branch November 26, 2024 08:24
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 kind/bug Issues related with bugs in the documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

BPMN elements render awkwardly too big on the page
3 participants