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

Rename "Render Expression" button in Outputs Tab #4396

Closed
Ben8t opened this issue Jul 22, 2024 · 7 comments
Closed

Rename "Render Expression" button in Outputs Tab #4396

Ben8t opened this issue Jul 22, 2024 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@Ben8t
Copy link
Member

Ben8t commented Jul 22, 2024

Feature description

The Render Expression button in the Outputs tab is very useful to debug Pebble syntax. However it's not very explicit in naming.
Some ideas:

  • Debug Pebble
  • Render Pebble
  • Pebble Debugger
  • Outputs Syntax Debugs
@Ben8t Ben8t added enhancement New feature or request kind/quick-win Seems to be quick to do area/frontend Needs frontend code changes labels Jul 22, 2024
@anna-geller
Copy link
Member

we can't use the word Pebble as it's not as well known as when you say "Jinja" :)

at first we'll try to make it more explicit that it's for Outputs in the new nested output UI where the expression is prefilled and you can edit and re-render some expressions with the large Render button. ofc if afterward it's still not clear that it's for rendering outputs, let's revisit then after #1528

image

@wrussell1999
Copy link
Member

Thoughts on simply naming the button "Debug Outputs" with a hover pop up that says you can put any expression in here to debug. I know you can do any expression with it, but that wasn't obvious to me as a user. Instead a debug expression button could also be added to the overview page maybe?

@anna-geller
Copy link
Member

Debug Outputs sounds great! I'll make the change in the UI. The challenge to you @wrussell1999 will be to update it in the docs — can you manage before vacation? if not, let's open an issue to adjust docs (we'll likely need to adjust many Output-related docs pages for the new outputs anyways)

@wrussell1999
Copy link
Member

yup I can sort this out before the end of the week 🚀

@wrussell1999 wrussell1999 reopened this Jul 25, 2024
@anna-geller anna-geller added documentation Improvements or additions to documentation and removed enhancement New feature or request area/frontend Needs frontend code changes kind/quick-win Seems to be quick to do labels Jul 25, 2024
anna-geller added a commit that referenced this issue Jul 25, 2024
@anna-geller
Copy link
Member

I wonder even about Debug Execution or Debug Context as in the end you can even retrieve {{ execution }}

for now I changed to:

      "title": "Debug Outputs",
      "tooltip": "Render any Pebble expression and inspect the Execution context."

@wrussell1999
Copy link
Member

Yeah that's the challenge, it does a lot of things! I think having a separate debug button on the overview page could solve this too. Both do the same thing but clearer where to find them!

@anna-geller
Copy link
Member

I see Will updated docs, so we're good now kestra-io/docs@56c5743

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

3 participants