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

Add link to FEEL temporal expression examples #4428

Merged
merged 12 commits into from
Nov 5, 2024

Conversation

falko
Copy link
Member

@falko falko commented Oct 8, 2024

Description

Link to very helpful examples from FEEL Scala docs

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

Copy link
Contributor

github-actions bot commented Oct 8, 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.6/.

  • docs/components/modeler/feel/language-guide/feel-context-expressions.md
  • docs/components/modeler/feel/language-guide/feel-list-expressions.md
  • docs/components/modeler/feel/language-guide/feel-temporal-expressions.md

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.

@akeller akeller requested a review from a team October 8, 2024 13:37
@akeller
Copy link
Member

akeller commented Oct 8, 2024

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? 🙂

@mesellings mesellings requested review from mesellings and removed request for a team October 8, 2024 13:42
@mesellings
Copy link
Contributor

@falko I'll take a look and backport as well for you 👍

@mesellings mesellings added kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) component:docs Documentation improvements, including new or updated content labels Oct 8, 2024
@falko
Copy link
Member Author

falko commented Oct 8, 2024

The same FEEL Scala docs section also contains examples for other topics. Maybe we should just add them to the docs? @saig0 FYI

@saig0
Copy link
Member

saig0 commented Oct 9, 2024

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

@mesellings
Copy link
Contributor

@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:

Info: Temporal expression examples are available in the FEEL-Scala documentation, including how to compare and check dates, calculate age and duration, and change date format.

Then, we address moving relevant docs over (such as these examples) as part of a larger project?

@falko
Copy link
Member Author

falko commented Oct 9, 2024

@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.

@akeller
Copy link
Member

akeller commented Oct 16, 2024

@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?

@mesellings mesellings added the deploy Stand up a temporary docs site with this PR label Nov 1, 2024
@mesellings
Copy link
Contributor

@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:

  • These examples are now branched off from the FEEL-Scala documentation and we will only update these in the Camunda 8 documentation.
  • The playground integration is being investigated by @pepopowitz and @saig0. It is not included in the scope of this PR.

@mesellings mesellings requested a review from saig0 November 1, 2024 09:03
@mesellings
Copy link
Contributor

Note, once these are approved by Engineering, I will add @camunda/tech-writers for review.

@github-actions github-actions bot temporarily deployed to camunda-docs November 1, 2024 09:13 Destroyed
Copy link
Member

@saig0 saig0 left a 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. 🍪

mesellings
mesellings previously approved these changes Nov 1, 2024
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

@falko @saig0 I've committed the comments and made changes from @saig0 review, I'm happy to approve this PR now @falko if you are happy with the code suggestions applied from the @saig0 review 👍

@mesellings mesellings requested a review from saig0 November 1, 2024 14:15
@github-actions github-actions bot temporarily deployed to camunda-docs November 1, 2024 14:31 Destroyed
saig0
saig0 previously approved these changes Nov 4, 2024
Copy link
Member

@saig0 saig0 left a 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. 🎉

@saig0 saig0 dismissed stale reviews from mesellings and themself via 3421eb0 November 4, 2024 10:12
Copy link
Member

@saig0 saig0 left a 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. 👍

@github-actions github-actions bot temporarily deployed to camunda-docs November 4, 2024 10:29 Destroyed
@mesellings
Copy link
Contributor

@falko Do you want me to merge and release this work?

Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Lgtm 👍 🚀

@mesellings mesellings merged commit 2a46437 into main Nov 5, 2024
6 checks passed
@mesellings mesellings deleted the feel-temporal-expression-examples branch November 5, 2024 09:22
@mesellings
Copy link
Contributor

@falko I've merged for you and I'll do a docs release this week to get the work out 👍

@mesellings mesellings removed the deploy Stand up a temporary docs site with this PR label Nov 5, 2024
Copy link
Contributor

github-actions bot commented Nov 5, 2024

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

4 participants