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

docs: adding algokit template documentation #300

Merged
merged 13 commits into from
Jul 14, 2023
Merged

Conversation

negar-abbasi
Copy link
Contributor

No description provided.

@github-actions
Copy link

github-actions bot commented Jul 4, 2023

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/algokit
   __init__.py15753%6–13, 17–24, 32–34
   __main__.py220%1–3
src/algokit/cli
   completions.py105298%80, 95
   deploy.py55493%34–36, 78
   doctor.py48394%142–144
   generate.py30197%49
   goal.py30197%42
   init.py1901692%264–265, 315, 318–320, 331, 375, 401, 441, 450–452, 455–460, 473
   localnet.py91397%157, 178–179
src/algokit/core
   bootstrap.py1612485%103–104, 126, 149, 214, 217, 223–237, 246–251
   conf.py54885%10, 24, 28, 36, 38, 71–73
   deploy.py591083%60–63, 72–73, 77, 82, 89–91
   doctor.py65789%67–69, 92–94, 134
   log_handlers.py68790%50–51, 63, 112–116, 125
   proc.py45198%98
   sandbox.py1501590%100–107, 118, 226, 242, 257–259, 275
   typed_client_generation.py80594%55–57, 70, 75
   version_prompt.py73889%27–28, 40, 59–62, 80, 109
TOTAL148512492% 

Tests Skipped Failures Errors Time
232 0 💤 0 ❌ 0 🔥 17.707s ⏱️

docs/tutorials/algokit-template.md Outdated Show resolved Hide resolved
docs/tutorials/algokit-template.md Outdated Show resolved Hide resolved
docs/tutorials/algokit-template.md Outdated Show resolved Hide resolved
docs/tutorials/algokit-template.md Outdated Show resolved Hide resolved
docs/tutorials/algokit-template.md Outdated Show resolved Hide resolved
docs/tutorials/algokit-template.md Outdated Show resolved Hide resolved
docs/tutorials/algokit-template.md Outdated Show resolved Hide resolved
docs/tutorials/algokit-template.md Show resolved Hide resolved
@negar-abbasi negar-abbasi requested a review from aorumbayev July 6, 2023 07:08
Copy link
Collaborator

@aorumbayev aorumbayev left a 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.

docs/tutorials/algokit-template.md Show resolved Hide resolved
docs/tutorials/algokit-template.md Show resolved Hide resolved
docs/tutorials/algokit-template.md Show resolved Hide resolved
docs/tutorials/algokit-template.md Show resolved Hide resolved
- [Template Answers and Variables](#template-answers-and-variables)
- [Recommendations](#recommendations)
- [Conclusion](#conclusion)

Copy link
Collaborator

@aorumbayev aorumbayev Jul 10, 2023

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.

@negar-abbasi negar-abbasi requested review from aorumbayev and daniel-makerx and removed request for achidlow July 11, 2023 23:58
Copy link
Collaborator

@aorumbayev aorumbayev left a 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

docs/tutorials/algokit-template.md Outdated Show resolved Hide resolved
@negar-abbasi negar-abbasi requested a review from aorumbayev July 12, 2023 09:55
docs/features/init.md Outdated Show resolved Hide resolved
@Loedn
Copy link
Contributor

Loedn commented Jul 13, 2023

all clear on my end

@aorumbayev
Copy link
Collaborator

@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

@aorumbayev aorumbayev merged commit 6e19743 into main Jul 14, 2023
@aorumbayev aorumbayev deleted the algokit-template-guide branch August 3, 2023 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants