-
Notifications
You must be signed in to change notification settings - Fork 47
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
docs: adding algokit template documentation #300
Conversation
Coverage Report
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just final set of comments from my side and we are good to go for this initial version of the tutorial. Unless any further comments from @achidlow or @daniel-makerx
@joe-p feel free to check as well if you have any further suggestions before we merge this. The goal here is to set a starting point for a more detailed doc for template builders (currently we only have a few paragraphs on algokit docs that primarily just forward to beaker repo or copier docs). This doc is set to set more explicit context on templates structure and etc.
- [Template Answers and Variables](#template-answers-and-variables) | ||
- [Recommendations](#recommendations) | ||
- [Conclusion](#conclusion) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's add another section called quick start in here before any other sections, because despite overview of the templates itself we still don't directly provide a guide on how exactly to create them for users. So it will serve a quick TL;DR section that users runs over before diving into reading the tutorial because he will need the reference beaker template anyway.
Since we are assuming beaker templates lets do a simple set of numbered items on things that a template builder needs to setup before they read the remaining part of this tutorial.
Something like:
For users who are keen on getting started with creating AlgoKit templates, you can follow these quick steps:
1. Click on `Use this template`->`Create a new repository` on [algokit-beaker-default-template](https://github.com/algorandfoundation/algokit-beaker-default-template) Github page. This will create a new reference repository with clean git history, allowing you to start modifying and transforming the base beaker template into your own custom template.
2. Modify the cloned template according to your specific needs. You can refer to the remainder of this tutorial for an understanding of expected behaviors from the AlgoKit side, Copier - the templating framework, and key concepts related to the default files you will encounter in the reference template.
@Loedn please note merging this PR assumes we turned the repos to template repos (at least the beaker repository) so this ways folks wouldn't need to Clone-> Clear git history each time but just make a templage repo from base template repo.
Co-authored-by: Al <[email protected]>
Co-authored-by: Al <[email protected]>
Co-authored-by: Al <[email protected]>
Co-authored-by: Al <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@negar-abbasi aside from minor typo comment just one extra ref I think we would want to include is:
On this doc https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/init.md#community-templates, please modify the:
If you want to create a community template, you can use the [beaker template](https://github.com/algorandfoundation/algokit-beaker-default-template) and [Copier documentation](https://copier.readthedocs.io/en/stable/) as a starting point.
to instead point out to this document because that essentially expands a lot on how templates work and how to quick start making your own.
Once addressed I'll approve the changes.
@Loedn so i think devrel is ok with using the templates feature? If yes lmk if you can approve this once template repos have template toggle enabled and we can merge this
all clear on my end |
@Loedn please keep in mind you'd need to turn full stack, react and beaker repos into template repos on github once 1.3.0 release is out |
No description provided.