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(web-modeler): switch to SBOM dependency list #4338

Merged
merged 2 commits into from
Sep 25, 2024

Conversation

wollefitz
Copy link
Member

@wollefitz wollefitz commented Sep 23, 2024

Description

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

@wollefitz wollefitz added hold This issue is parked, do not merge. component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS component:web-modeler-sm Issues related with Web Modeler Self-Managed labels Sep 23, 2024
@wollefitz wollefitz self-assigned this Sep 23, 2024
@wollefitz wollefitz added the target:8.6 Issues included in the 8.6 release label Sep 23, 2024
@wollefitz wollefitz marked this pull request as ready for review September 24, 2024 12:29
@wollefitz
Copy link
Member Author

Hey @MaxTru and/or @kevinCamunda!

Could you please have a look at the proposed wording of the Web Modeler dependencies section meets our requirements?

  • Dependencies: SBOM CycloneDX files with up-to-date lists of third party libraries used and their licenses can be requested on demand.
  • Source code: Source code access can be provided on demand.

Do we have to mention SaaS and SM (and their individual components webapp, restapi and websockets) separately or is this sufficient?

docs/reference/dependencies.md Outdated Show resolved Hide resolved
@MaxTru
Copy link
Contributor

MaxTru commented Sep 24, 2024

Hi @wollefitz ,

thanks - looks good! Just please include the email address already.

Note: I will go over the detailed wording once all components have done their part (ensuring consistency and legal aligned wording).

@wollefitz wollefitz force-pushed the web-modeler-4386-sbom branch 2 times, most recently from 6219415 to d84389b Compare September 24, 2024 12:55
@wollefitz wollefitz removed the hold This issue is parked, do not merge. label Sep 24, 2024
Copy link
Contributor

@MaxTru MaxTru left a comment

Choose a reason for hiding this comment

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

Just a small detail wording

docs/reference/dependencies.md Outdated Show resolved Hide resolved
@wollefitz
Copy link
Member Author

Additionally requesting a review from @camunda/tech-writers as I'm a bit confused by "on demand" vs "on-demand" - maybe you could assist me 🙂

@christinaausley
Copy link
Contributor

Additionally requesting a review from @camunda/tech-writers as I'm a bit confused by "on demand" vs "on-demand" - maybe you could assist me 🙂

"On demand" is correct here. You might use on-demand as an adjective preceding a noun to describe the noun -- for example, on-demand television".

@wollefitz
Copy link
Member Author

Thanks for having another look! Let's merge this then 🚀

@wollefitz wollefitz merged commit e9eceaa into main Sep 25, 2024
10 checks passed
@wollefitz wollefitz deleted the web-modeler-4386-sbom branch September 25, 2024 18:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS component:web-modeler-sm Issues related with Web Modeler Self-Managed target:8.6 Issues included in the 8.6 release
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants