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

Update Mixin Documentation and Skeletor with a "How To" #3172

Open
schristoff opened this issue Jul 1, 2024 · 4 comments
Open

Update Mixin Documentation and Skeletor with a "How To" #3172

schristoff opened this issue Jul 1, 2024 · 4 comments
Labels
docs Markdown ahoy! Updates needed on porter.sh or in dev docs.

Comments

@schristoff
Copy link
Member

A tutorial that shows the user how to write a mixin would be great.
We should leverage existing documentation https://porter.sh/docs/how-to-guides/work-with-mixins/ , https://porter.sh/docs/development/dev-a-mixin/

@schristoff schristoff added the suggestion Idea for maintainers to consider. Do not take this issue until triaged. label Jul 1, 2024
@kichristensen kichristensen added docs Markdown ahoy! Updates needed on porter.sh or in dev docs. and removed suggestion Idea for maintainers to consider. Do not take this issue until triaged. labels Jul 27, 2024
@Pushkarmondal
Copy link

Hey @kichristensen @schristoff can I work on this?

@kichristensen
Copy link
Contributor

@Pushkarmondal its would be awesome if you would take a look at this issue. Please reach out if you need any help, we are happy to help

@Pushkarmondal
Copy link

Sure

@lbergnehr
Copy link
Contributor

Possibly out of scope, but take it for what it's worth: sometimes you cannot write your mixin using Skelletor, or in Go at all for that matter. In that case, it can be hard to understand what the mixin interface is. When I just started creating mixins I made a bash script that would simply print everything that Porter ran it with (parameters, stdin). I think it would be great to have such a "test" or "debug" mixin, or possibly just the documentation on a script that would do it and the documentation on how to install it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Markdown ahoy! Updates needed on porter.sh or in dev docs.
Projects
Development

No branches or pull requests

4 participants