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): remove beta notice for Web Modeler API #2617

Merged
merged 4 commits into from
Sep 21, 2023

Conversation

wollefitz
Copy link
Member

@wollefitz wollefitz commented Sep 20, 2023

Description

Removes the beta notice from Web Modeler's API section as the API is going GA. v1 will not be backported to Web Modeler SM 8.2 which is why we will have a hybrid state in the 8.2 docs where for SaaS, we talk about v1 and for SM, we talk about beta.

Closes https://github.com/camunda/web-modeler/issues/5239

When should this change go live?

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), ~or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@wollefitz wollefitz added component:modeler Issues related with Modeler project hold This issue is parked, do not merge. labels Sep 20, 2023
@wollefitz wollefitz self-assigned this Sep 20, 2023
@wollefitz wollefitz force-pushed the web-modeler-5239-api-ga branch 4 times, most recently from 8b3e24f to 5d0697b Compare September 20, 2023 09:33
@wollefitz wollefitz added kind/feature Issues related with features to be documented and removed hold This issue is parked, do not merge. labels Sep 20, 2023
@wollefitz
Copy link
Member Author

@christinaausley I wasn't sure if we also want to mention the Web Modeler API in this section:

https://github.com/camunda/camunda-platform-docs/blob/d0c2e2675876cb293f513ea3ec16ddcad8288079/docs/apis-tools/public-api.md?plain=1#L18-L24

As for example, Optimize is also not mentioned there. Maybe you can shed some light here.

@wollefitz wollefitz marked this pull request as ready for review September 20, 2023 09:40
@christinaausley
Copy link
Contributor

@christinaausley I wasn't sure if we also want to mention the Web Modeler API in this section:

https://github.com/camunda/camunda-platform-docs/blob/d0c2e2675876cb293f513ea3ec16ddcad8288079/docs/apis-tools/public-api.md?plain=1#L18-L24

As for example, Optimize is also not mentioned there. Maybe you can shed some light here.

@akeller Is there a reason we haven't added these to this list? If they are officially supported, I assume we likely should.

@akeller
Copy link
Member

akeller commented Sep 21, 2023

@akeller Is there a reason we haven't added these to this list? If they are officially supported, I assume we likely should.

I never got around to removing this page or adding an issue about it. - #1581 (comment)

TBH, there has been some back and forth about removing this page, but as the DRI of documentation, let's just remove it. The most value I see is around stating backward compatibility and versioning, but our versioning is not consistent across APIs.

@akeller
Copy link
Member

akeller commented Sep 21, 2023

I will remove this page in another PR, no update needed here.

@akeller akeller mentioned this pull request Sep 21, 2023
9 tasks
@wollefitz
Copy link
Member Author

TBH, there has been some back and forth about removing this page, but as the DRI of documentation, let's just remove it. The most value I see is around stating backward compatibility and versioning, but our versioning is not consistent across APIs.

Thanks for the insights!

@christinaausley If there are no additional remarks from your side could we merge this PR?

@akeller akeller enabled auto-merge (squash) September 21, 2023 19:20
@akeller akeller merged commit a24d03e into main Sep 21, 2023
4 checks passed
@akeller akeller deleted the web-modeler-5239-api-ga branch September 21, 2023 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:modeler Issues related with Modeler project kind/feature Issues related with features to be documented
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants