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

chore(docs): migrate modeler c7 only docs from c8 #1759

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

christinaausley
Copy link
Contributor

@christinaausley christinaausley commented Mar 25, 2025

Based on camunda/camunda-docs#5312 (comment).

Moving defining templates and HTTL back into C7 from the C8 docs.

Still to do:

@christinaausley christinaausley requested a review from barmac March 25, 2025 19:05
@christinaausley christinaausley self-assigned this Mar 25, 2025
@christinaausley christinaausley added bot:backport:7.21 Backports PR to maintenance branch 7.21. bot:backport:7.22 Backports PR to maintenance branch 7.22. bot:backport:latest Backports PR to maintenance branch latest. labels Mar 25, 2025
@barmac
Copy link
Contributor

barmac commented Mar 27, 2025

Thank you @christinaausley for your work on this.

I noticed that the images wouldn't load due to hugo specific way of handling them, so I fixed the paths. I'd like to move the "Defining templates" section to "Element templates", and bring back some kind of introduction. I can handle that beginning next week.

For the flags, we could add a page in Modeler section that will redirect the user to C8 docs. I would rather not have separate pages documenting some of the flags in C7 docs, and some in C8 docs. All of the flags (including the one on history time to live) should be documented in one place as they belong to the same application, even if it means that a C7-specific flag leaks to C8 docs. What do you think?

I migrated over the HTTL doc as well

Thank you. I think this page may be placed in the Modeler section, and link back to the process engine docs for technical details.

@christinaausley
Copy link
Contributor Author

christinaausley commented Mar 28, 2025

For the flags, we could add a page in Modeler section that will redirect the user to C8 docs. I would rather not have separate pages documenting some of the flags in C7 docs, and some in C8 docs. All of the flags (including the one on history time to live) should be documented in one place as they belong to the same application, even if it means that a C7-specific flag leaks to C8 docs. What do you think?

@barmac So you would prefer to keep the C7-related flags in the C8 docs? I'm fine with this exception.

Thank you. I think this page may be placed in the Modeler section, and link back to the process engine docs for technical details.

I'll move this in an incoming commit. Do you have a preference for where in the Modeler section? Perhaps Reference, unless you want this nested below a particular area in the user guide based on the developer journey.

@barmac
Copy link
Contributor

barmac commented Mar 28, 2025

So you would prefer to keep the C7-related flags in the C8 docs? I'm fine with this exception.

Correct!

I'll move this in an incoming commit. Do you have a preference for where in the Modeler section? Perhaps Reference, unless you want this nested below a particular area in the user guide based on the developer journey.

I meant this section: https://docs.camunda.org/manual/latest/modeler/

@christinaausley
Copy link
Contributor Author

@barmac -- done. Feel free to work in this PR, or we can merge this and the open C8 docs PR if you'd like to work in a separate branch.

- Move "Defining" part to the main Element Templates page.
- Add introduction to the page.
@barmac
Copy link
Contributor

barmac commented Apr 2, 2025

@christinaausley I've restructured the element templates part. Please have a look. From my perspective, it's ready to be merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:backport:latest Backports PR to maintenance branch latest. bot:backport:7.21 Backports PR to maintenance branch 7.21. bot:backport:7.22 Backports PR to maintenance branch 7.22.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants