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 documentation about how to debug a recipe with the Moderne CLI #53

Closed
rpau opened this issue Jul 14, 2023 · 6 comments
Closed

Add documentation about how to debug a recipe with the Moderne CLI #53

rpau opened this issue Jul 14, 2023 · 6 comments
Labels
blocked When an issue can't be worked on right now documentation Improvements or additions to documentation

Comments

@rpau
Copy link

rpau commented Jul 14, 2023

There are several use cases that the Moderne CLI has been designed for. One of them is to debug recipes with existing LSTs in the platform. That use case/example should be added in the documentation

@rpau rpau added the documentation Improvements or additions to documentation label Jul 14, 2023
@mike-solomon
Copy link
Contributor

@rpau When you have some time, could you or someone on the devex team please provide some more context into this? I'm not sure how someone would debug recipes with existing LSTs using the CLI.

Y'all could either write a doc and I can then go through and review it - or y'all could provide me some specific examples for this doc.

At the very least, I'd want to see:

  • Examples of the CLI commands people should run (such as mod run ...)
  • Examples of what these commands look like when being run (the output)
  • An example of something you might debug (like is it that the recipe just doesn't run? or perhaps an example of something that wasn't quite right)
  • How you would go about fixing this issue and iterating on it.

@mike-solomon mike-solomon added the blocked When an issue can't be worked on right now label Jul 20, 2023
@kmccarp
Copy link
Contributor

kmccarp commented Jan 3, 2024

@mike-solomon We might be in a better state for this now?

@mike-solomon
Copy link
Contributor

@kmccarp I think we're in the same state of, "If someone has time to provide an example demonstrating this then a doc can be made." As it stands, I'm not too familiar with recipe development, what common mistakes people run into, and how the CLI might help them with those mistakes.

@sjungling
Copy link
Member

@mike-solomon still the same as 5 months ago?

@mike-solomon
Copy link
Contributor

@sjungling Ya i’m not sure if this even applies anymore as the intellij connections handle this so much better now.

@sjungling
Copy link
Member

good enough to close for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked When an issue can't be worked on right now documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants