document and common question archived

[thinkerou]

Background:

• Now we have README.md document which includes most useful document, but some common question are frequently asked. So we should archive the frequently question and add some architecture document.

Hope everyone can take part in the work, thanks!

example:

• how to build one effective middleware? document: add docs dir and middleware document #1521
• about template
• and so on.

[isgj]

Are you considering making a web-site for Gin? Instead of using the gh-pages branch in this repository
you can create a new repository that is dedicated for the web-site so the examples, docs and other can be structured well. The README.md should be cleaner without the examples.

[thinkerou]

@isgj approve to create a new repository and migrate gh-pages branch.

[syssam]

@isgj agree. I think we should build a website, like
https://echo.labstack.com/
https://iris-go.com/

[thefury]

This is something I'd be happy to help out on.

[isgj]

Hi everyone i started here an idea for a new website. It is really at the beginning and a lot has to be done. At the moment it looks like

It is made with hugo.
Anything that pass by your mind is welcome.

[charly3pins]

Hi @isgj , I like the idea of using Hugo! Maybe it's better create the repo in github to facilitate the contribution? I'm interested on contribute in it if it's possible

[isgj]

Sure here it is. I'm using hugo for the first time so please be polite 😨

[dlaub3]

I can help with this site as well. I use Hugo for my blog, so I have some experience.

[appleboy]

@thinkerou maybe we need the new domain and create a new repository to put the source of website using Hugo.

[thinkerou]

OK, I see... at weekends.

[syssam]

@appleboy gin is a framework, why not use gin?

[appleboy]

@syssam We don't have the free VM to host the website using the gin framework.

[dlaub3]

It might be possible to run a free Heroku instance or use https://glitch.com. Then we could use Gin, but we may not have a custom domain name.

[appleboy]

I think Hugo is the best solution for everyone. We can create a new repo and choose the free theme of Hugo. I can buy a new domain for gin framework.

[isgj]

If you want here is some work already done https:github.com/isgj/gin-web. I can transfer the ownership of the repo.

[thefury]

I completely agree that a static site would be better suited for this. Unless there's something I'm missing, there's no need to add the operational complexity of running a framework based site.

[dlaub3]

Was a decision made to move forward with Hugo? I would like to contribute.

[appleboy]

The following steps we need to do.

1. create a new repo for documentation webpage (maybe website name of repo)
2. buy a new domain and set custom domain in new repo.
3. integrate Travis with Hugo to deploy static page.

cc @javierprovecho @thinkerou

[thinkerou]

@appleboy agreed!

[appleboy]

1. create a new repo for documentation webpage (maybe website name of repo) See website repo
2. buy a new domain and set custom domain in new repo.
3. integrate Travis with Hugo to deploy static page.

[appleboy]

update status: New domain: gin-gonic.com already done. Thanks for @javierprovecho . Everyone can watch the website repo.

[thinkerou]

first commit includes init hugo project and theme option, please see and review gin-gonic/website#1, thanks!

[thinkerou]

Hi everybody, the first version Gin website have completed, thanks everybody!
please see https://gin-gonic.com/