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

Create a thorough Tutorial guide for using Tirith #156

Open
refeed opened this issue Aug 2, 2024 · 4 comments
Open

Create a thorough Tutorial guide for using Tirith #156

refeed opened this issue Aug 2, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation hacktoberfest

Comments

@refeed
Copy link
Member

refeed commented Aug 2, 2024

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 refeed added documentation Improvements or additions to documentation need-discussion The requirements isn't clear yet, need more thorough discussion and removed need-discussion The requirements isn't clear yet, need more thorough discussion labels Aug 2, 2024
@refeed
Copy link
Member Author

refeed commented Aug 2, 2024

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

@harshit240205
Copy link

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!

@refeed refeed changed the title Create a thorough Getting Started guide for using Tirith Create a thorough Tutorial guide for using Tirith Aug 15, 2024
@Aman1905
Copy link
Contributor

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)

@refeed
Copy link
Member Author

refeed commented Oct 22, 2024

Thanks that looks great

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest
Projects
None yet
Development

No branches or pull requests

3 participants