platforms-on-k8s icon indicating copy to clipboard operation
platforms-on-k8s copied to clipboard

Instructions can be polished for a smoother walkthrough experience

Open kmacedovarela opened this issue 1 year ago • 2 comments

Currently, the awesome guide you've put together is super helpful to learners. I do notice potential ways to enhance the reader's hands-on experience and make it easier for different levels of audiences to follow through.

Feel free to drop suggestions that are not aligned with the project's original objectives.

Some overall enhancements would be:

  • [ ] Usage of admonitions where appropriate, instead of mostly raw text
  • [ ] A list of the environments currently supported (e.g., currently only sh scripts are available, so it would be cool to share it's been tested only on e.g., Unix, etc and that PRs for windows are welcome)
  • [x] #39
  • [x] #38
  • [x] #36

( As I move forward on trying out the examples, I may add more items to the list).

I will send PRs related to items above considering it won't impact existing translations.

If enhancements like these are welcome, I believe the current early stage would be the best moment to add them.

kmacedovarela avatar Sep 15 '23 23:09 kmacedovarela

@kmacedovarela yes to all! All these style improvements will help the readers a lot. So if you can send a PR with some examples, I can slowly go through the rest of the chapters and apply the changes in all of them. Please create issues if you find things that can be improved.. so we can keep track and we don't forget about them

salaboy avatar Sep 16 '23 07:09 salaboy

@kmacedovarela any update on this? all your suggestions were highly appreciated!

salaboy avatar Oct 25 '23 16:10 salaboy