-
Notifications
You must be signed in to change notification settings - Fork 185
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 link to FEEL temporal expression examples #4428
Conversation
👋 🤖 🤔 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.6/.
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. |
I'd like to see a little more context around this link, but we should probably also backport it, maybe to all supported versions. @camunda/tech-writers can one of you assist Falko with both of those things? 🙂 |
@falko I'll take a look and backport as well for you 👍 |
The same FEEL Scala docs section also contains examples for other topics. Maybe we should just add them to the docs? @saig0 FYI |
@falko instead of adding a link to the FEEL-Scala docs, I would prefer adding the examples directly in the C8 docs. On a long-term, I would move all relevant content to the Camunda docs (and the code itself to the Camunda repo). |
@saig0 @falko I think moving content into the docs may be quite a lift for this PR, and probably something we need to plan out - there are issues such as redirects/links to the github docs for example that we need to take into consideration. Can I suggest the following plan: For now (for this PR) we add the links in as suggested, and we can reference the examples a bit more clearly. For example:
Then, we address moving relevant docs over (such as these examples) as part of a larger project? |
@akeller can we just merge all examples from here: https://github.com/camunda/feel-scala/tree/main/docs/docs/learn/samples Really helpfule, would be to somehow integrate the FEEL playground into the docs so that users can directly modify the examples to match their use cases. It could be done as a link near each example or even directly like how @saig0 did it in his FEEL Challenge. Having the examples in the playground could also be a way to maintain them, i.e. test that they still work. |
Let's handle integrating the playground in a separate issue/PR scope so we can pull in @pepopowitz to incorporate this. @pepopowitz can you sync with @saig0 and create an issue for this? We can merge the examples/samples into the C8 docs, but I want to be clear DevEx wouldn't update them in both places. So within the scope of this PR, instead of linking, we would add list, context, and temporal expression examples to the existing pages in the C8 docs. @mesellings can you rework this PR? Or open a new one and add @falko and @saig0 as reviewers? |
@falko @saig0 Please review - I have added the examples into the context, temporal, and list expressions pages. and edited for conciseness, typos, and structure. If you are happy with these changes, I will backport for other doc versions (8.6 > 8.2). Note: As mentioned:
|
Note, once these are approved by Engineering, I will add @camunda/tech-writers for review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mesellings thank you for adding the examples. 👍
I added a few comments. Please have a look. 🍪
docs/components/modeler/feel/language-guide/feel-context-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-context-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-context-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-list-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-list-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-temporal-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-temporal-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-temporal-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-temporal-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-temporal-expressions.md
Outdated
Show resolved
Hide resolved
…ssions.md Co-authored-by: Philipp Ossler <[email protected]>
…ssions.md Co-authored-by: Philipp Ossler <[email protected]>
…ons.md Co-authored-by: Philipp Ossler <[email protected]>
…essions.md Co-authored-by: Philipp Ossler <[email protected]>
Co-authored-by: Philipp Ossler <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mesellings great work. LGTM. 🎉
docs/components/modeler/feel/language-guide/feel-list-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-list-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-temporal-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-temporal-expressions.md
Outdated
Show resolved
Hide resolved
docs/components/modeler/feel/language-guide/feel-temporal-expressions.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Edit: I removed the tailing semicolons from some code snippets. 👍
@falko Do you want me to merge and release this work? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lgtm 👍 🚀
@falko I've merged for you and I'll do a docs release this week to get the work out 👍 |
🧹 Preview environment for this PR has been torn down. |
Description
Link to very helpful examples from FEEL Scala docs
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).