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

Feature request > Document the --listfixers command line option with Katacoda #58

Open
6 of 7 tasks
tamere-allo-peter opened this issue Mar 20, 2022 · 15 comments
Open
6 of 7 tasks
Assignees
Labels
BUILD communication documentation Improvements or additions to documentation

Comments

@tamere-allo-peter
Copy link
Member

tamere-allo-peter commented Mar 20, 2022

📜 Read (and accept) this before

  • I am respectful : this is free software and efforts are made on free time, with 💙
  • I have looked at the current project roadmap
  • I have already looked in current and past issues so I'm sure others did not already push a simlar issue
  • I make one single issue per feature request so the team can work efficienlty on it
  • I am aware of Unix philosophy : Make each program do one thing well
  • When (and if) your feature is implemented, be thnankful and help promote the project by sharing the issue on social networks (twitter, linkedIn, dev.to...) and droppig the url on te issue

❔ Context

  • yamlfixer v0.3.9 introduces the --listfixers command line option to list the problems reported by yamllint that yamlfixer knows how to fix.

👉 It would be great to document this with Katacoda.

💡 Proposed solution

  • Modify the Katacoda scenario to document this new feature.
@tamere-allo-peter tamere-allo-peter added documentation Improvements or additions to documentation communication labels Mar 20, 2022
@adriens
Copy link
Member

adriens commented Mar 20, 2022

Yep, great idea 👍

@tamere-allo-peter
Copy link
Member Author

@adriens How are your calves ?

@adriens
Copy link
Member

adriens commented Mar 20, 2022

@tamere-allo-peter : Does --listfixers switch have a short version ? (-l) ❔

@tamere-allo-peter
Copy link
Member Author

Yes, see README or --help :)

@adriens
Copy link
Member

adriens commented Mar 20, 2022

👍
image

@tamere-allo-peter
Copy link
Member Author

@adriens The --listfixes option name was changed a while ago to --listfixers to better represent what it does. So the picture above is not accurate anymore.

@adriens
Copy link
Member

adriens commented Apr 19, 2022

@adriens The --listfixes option name was changed a while ago to --listfixers to better represent what it does. So the picture above is not accurate anymore.

OK, can you please drop me a dedicated issue so I upgrade the documentation 🙏

@tamere-allo-peter tamere-allo-peter changed the title Feature request > Document the --listfixes command line option with Katacoda Feature request > Document the --listfixers command line option with Katacoda Apr 19, 2022
@tamere-allo-peter
Copy link
Member Author

@adriens I don't understand what you want to upgrade besides the image above, since the present issue is precisely about documenting this feature. It being still open means there's no documentation to upgrade.

@adriens
Copy link
Member

adriens commented Apr 19, 2022

I mean : documenting a screenshot on the README is not the same thing than documenting it on katacoda 😸

@tamere-allo-peter
Copy link
Member Author

@adriens sorry I talked about the image above only (and btw didn't ask for you to replace it, it was just FYI), not about the demo at the top of the README... Don't worry with this, I don't think doing screenshots/demos before all command line options are implemented is a waste of time. And I've got some new ideas to add as command line options ;)

@adriens
Copy link
Member

adriens commented Apr 19, 2022

Got it dude 😸

@adriens
Copy link
Member

adriens commented Apr 19, 2022

At a given phasis, we'll have to pay good attention to breaking changes as it may have impact on our tool's popularity 👍

@tamere-allo-peter
Copy link
Member Author

LOL. That's what tests are for ! And yes, they are coming sooner than later...

@adriens
Copy link
Member

adriens commented Apr 19, 2022

💟

@tamere-allo-peter
Copy link
Member Author

@adriens : http://www.catb.org/jargon/html/Z/Zawinskis-Law.html

@adriens adriens added the BUILD label Apr 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BUILD communication documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants