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): document file download and export options #3309

Merged
merged 3 commits into from
Feb 12, 2024

Conversation

jfriedenstab
Copy link
Contributor

@jfriedenstab jfriedenstab commented Feb 9, 2024

Description

Documents the file download and export options in Web Modeler.

Part of https://github.com/camunda/product-hub/issues/1959.
Closes https://github.com/camunda/web-modeler/issues/5286.

When should this change go live?

  • This change is not yet live and should not be merged until Feb 13 (8.5.0-alpha1 release 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.

@jfriedenstab jfriedenstab added component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS component:web-modeler-sm Issues related with Web Modeler Self-Managed labels Feb 9, 2024
@jfriedenstab jfriedenstab self-assigned this Feb 9, 2024
@jfriedenstab jfriedenstab added the hold This issue is parked, do not merge. label Feb 9, 2024
Copy link
Contributor

github-actions bot commented Feb 9, 2024

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

  • docs/components/modeler/web-modeler/file-download.md
  • docs/components/modeler/web-modeler/img/download/download-bpmn.png
  • docs/components/modeler/web-modeler/img/download/download-connector-template.png
  • docs/components/modeler/web-modeler/img/download/download-dmn.png
  • docs/components/modeler/web-modeler/img/download/download-form.png
  • docs/components/modeler/web-modeler/img/download/multi-file-download.png
  • docs/components/modeler/web-modeler/img/download/single-file-download.png

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.

Copy link
Contributor

@HanselIdes HanselIdes left a comment

Choose a reason for hiding this comment

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

Overall LGTM - I suggested some ways to clarify the value and shorten the text. Overall, the UI for this kind of feature should be self-explanatory enough that documentation can be light. The main 'gotchas' were covered nicely: the download limit and different behavior between project view and file editor view.

You do not need to re-request my review.

jfriedenstab and others added 2 commits February 12, 2024 08:02
Co-authored-by: Eric Lundberg <ericlundberg09@gmail.com>
Co-authored-by: Eric Lundberg <ericlundberg09@gmail.com>
@jfriedenstab
Copy link
Contributor Author

Thanks @HanselIdes! 👍🏻 I've adopted your suggestions.

@jfriedenstab jfriedenstab removed the hold This issue is parked, do not merge. label Feb 12, 2024
Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

Nice writing here!

@jfriedenstab
Copy link
Contributor Author

@HanselIdes To allow me to merge the PR, I think you need to approve it (because you requested changes).

@jfriedenstab jfriedenstab merged commit 7932e44 into main Feb 12, 2024
7 of 8 checks passed
@jfriedenstab jfriedenstab deleted the web-modeler-5286-download-and-export branch February 12, 2024 19:21
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants