search

checkly / jamstack-deploy

Measure cloud providers and check which fits better for your Jamstack App.
https://jamstackdeploy.com
MIT License
32 stars 9 forks source link

Add "how to" guides for each provider #11

Open ianaya89 opened 2 years ago

kokamkarsahil commented 2 years ago

Hello, I would like to work on it. Can we discuss it? Thank You!

ianaya89 commented 2 years ago

Hi @kokamkarsahil, thanks for your interest.

What I have in mind is that each provider has a descriptive page where you can easily read how to start using it and how to do your first deployment. I would also like to include a list of features that each provider has (SSL, custom domains, cli, UI, etc). We can start working on different MD files that we can keep in the repo as docs and maybe in the next iteration put that information in the web app (design needed)

What do you think? Is this something you would like to do?

kokamkarsahil commented 2 years ago

Thanks for reply!

What I have in mind is that each provider has a descriptive page where you can easily read how to start using it and how to do your first deployment.

Sure, I am bit confused in layout of the page. Like how the things will be nested.

I would also like to include a list of features that each provider has (SSL, custom domains, cli, UI, etc).

Got it. Like we can difference their free and paid offerings or just include whether it's supported without mentioning free or paid tier?

We can start working on different MD files that we can keep in the repo as docs and maybe in the next iteration put that information in the web app (design needed)

Sure! I won't mind using markdown.

What do you think? Is this something you would like to do?

I was planning on using static doc generators like kit docs, docusarus, vuepress or any other generators. But now I don't know how the web app will be styled, like how the layout will be?

Thank You! Would like to get clarified with the above stuff, then I will create a demo page with the above things in mind.

kokamkarsahil commented 2 years ago

Any updates @ianaya89 ?

ianaya89 commented 2 years ago

Hey @kokamkarsahil sorry, we were quite busy with some releases this week. Maybe worth to spend a few minutes in a call to go through this. Are you available next week to talk for a few minutes? You can reach me at nacho[at]checklyhq.com

Thanks :)

kokamkarsahil commented 2 years ago

Yup, we can talk about it in next week. And sorry for pinging didn't knew about the new release is coming. I have reached you via email My email: Sahil Kokamkar \sahil@kokamkar.com

kokamkarsahil commented 1 year ago

Hi @ianaya89, I created a demo https://jamstack-docs.vercel.app And a full doc for AWS-amplify: https://jamstack-docs.vercel.app/docs/providers/aws-amplify It's still W.I.P. Let me know if there are any issue or improvements. BTW didn't got any response through email.

ianaya89 commented 1 year ago

Hi @kokamkarsahil, so sorry for the silence I am on parental leave right now. Thanks a lot for the contribution, will take a deeper look this week and get back to you with feedback 💯

kokamkarsahil commented 1 year ago

Hi @kokamkarsahil, so sorry for the silence I am on parental leave right now.

Sorry for pinging, didn't know you were on leave.

Thanks a lot for the contribution, will take a deeper look this week and get back to you with feedback :100:

Sure no problem, will be waiting for your feedback :+1: And have a great day!

ianaya89 commented 1 year ago

Hi @kokamkarsahil, no problem at all. I just reviewed what you sent and looks fantastic. We can later discuss in more detail the sections and topics, but this is precisely what I have in mind.

Which tech stack are using for this? I would like to keep it in this same repo and use our existing app/repo. Do you think we can make it work?

Thanks!

kokamkarsahil commented 1 year ago

Hi @kokamkarsahil, no problem at all. I just reviewed what you sent and looks fantastic. We can later discuss in more detail the sections and topics, but this is precisely what I have in mind.

Yeah sure!

Which tech stack are using for this?

I have used kit docs which is based on svelte kit. And using Playwright for E2E testing + eslint. You also checkout the source code.

I would like to keep it in this same repo and use our existing app/repo. Do you think we can make it work?

Yes we can with the help of vercel.json. In case if the app size increases we can use something like TurboRepo.

Thanks!

Happy To Contribute! :hugs:

ianaya89 commented 1 year ago

@kokamkarsahil Looks great. What do you think about using Vuepress (or nuxt) for this? I would like to avoid having different tech stacks for the app and the docs. I think will be better for other contributors in the future, improve code re-using and make the project cleaner

kokamkarsahil commented 1 year ago

@kokamkarsahil Looks great. What do you think about using Vuepress (or nuxt) for this?

Yes it will be good and we can easily switch to it without any problem, but what do you think about vitepress?

I would like to avoid having different tech stacks for the app and the docs. I think will be better for other contributors in the future, improve code re-using and make the project cleaner

Yeah that makes sense. And how about using MDX instead of Markdown?

ianaya89 commented 1 year ago

@kokamkarsahil I am ok with both.
If vitepress is mature enough, let's go. MDX is also a great choice!

kokamkarsahil commented 1 year ago

@kokamkarsahil I am ok with both.
If vitepress is mature enough, let's go. MDX is also a great choice!

Unfortunately, both [vuepress] ( https://vuepress.vuejs.org/guide/markdown.html) and vitepress doesn't have support for steps using in the docs.

i.e The steps and number style used in markdown check the numbers and steps used here.