tirith icon indicating copy to clipboard operation
tirith copied to clipboard

Create a thorough Tutorial guide for using Tirith

Open refeed opened this issue 1 year ago • 4 comments

Is your feature request related to a problem? Please describe. Currently, there's only a little introduction on how to use Tirith. Ideally, there should be more tutorial for at least using three providers so that potential users and contributors can get a picture on how to use Tirith and what is Tirith

Describe the solution you'd like Create a separate markdown document inside the Tirith repo. Inspiration for what the document would like: https://github.com/refeed/tirith-workshop

I also think it would be a good idea to research on some other open/closed source projects on how they are doing the getting started part

Describe alternatives you've considered We may also create a document structure that's accepted by ReadTheDocs format, but we can do it in the next iteration.

refeed avatar Aug 02 '24 09:08 refeed

Several feedback from https://github.com/refeed/tirith-workshop

  • Have user run terraform init, plan to generate the plan and then use a policy
    • Create a null_resource
  • Name the input and policy files appropriately
  • Support different machine types

refeed avatar Aug 02 '24 09:08 refeed

Hi sir, I really want to work on this documentation. I Will write it in the similar format as asked. Kindly assign this task to me. Thank You!

harshit240205 avatar Aug 08 '24 17:08 harshit240205

Hey @refeed since i am already working on the above-related issue, docs structure and writing other pages, I would ask you to please assign this to me, here is the structure that I will be following

Tutorial
◦	CLI usage
◦	Integrating with CI/CD
◦	Using the library for doing evaluations in Python code
◦	(another real-world usecases)

Aman1905 avatar Oct 22 '24 06:10 Aman1905

Thanks that looks great

Edit: Very sorry @harshit240205, I didn't see your message previously

refeed avatar Oct 22 '24 12:10 refeed