Improve the documentation #762

@pgaskin commented on GitHub (Jun 1, 2017):

@lunny It's a static page which uses AJAX to load a JSON-based index and the page content. Have a look at the code on my server.

@pgaskin commented on GitHub (Jun 1, 2017): @lunny It's a static page which uses AJAX to load a JSON-based index and the page content. Have a look at the code on my server.

GiteaMirror commented

@lunny commented on GitHub (Jun 1, 2017):

Since Gitea is a community product, we should use the almost popular technical so that many people could contribute for her.

@lunny commented on GitHub (Jun 1, 2017): Since Gitea is a community product, we should use the almost popular technical so that many people could contribute for her.

GiteaMirror commented

@pgaskin commented on GitHub (Jun 1, 2017):

@lunny sorry, but what do you mean by the almost popular technical?

@pgaskin commented on GitHub (Jun 1, 2017): @lunny sorry, but what do you mean by the almost popular technical?

GiteaMirror commented

@pgaskin commented on GitHub (Jun 1, 2017):

If you mean technologies, I think my method is better than hugo, because hugo has it's limits. I am using popular libraries such as jquery and semantic ui though.

Have a look at my code. It's pretty easy to understand and it will end up as only about 200-400 lines.

@pgaskin commented on GitHub (Jun 1, 2017): If you mean technologies, I think my method is better than hugo, because hugo has it's limits. I am using popular libraries such as jquery and semantic ui though. Have a look at my code. It's pretty easy to understand and it will end up as only about 200-400 lines.

GiteaMirror commented

@appleboy commented on GitHub (Jun 1, 2017):

@geek1011 How to translate to other languages?

@appleboy commented on GitHub (Jun 1, 2017): @geek1011 How to translate to other languages?

GiteaMirror commented

@tboerger commented on GitHub (Jun 1, 2017):

Ajax to load the index? Pretty bad for search engine indexing...

@tboerger commented on GitHub (Jun 1, 2017): Ajax to load the index? Pretty bad for search engine indexing...

GiteaMirror commented

@tboerger commented on GitHub (Jun 1, 2017):

And I don't share your opinion that your technology is better than Hugo. Hugo generates a really static website which can be indexed and search engine optimized.

@tboerger commented on GitHub (Jun 1, 2017): And I don't share your opinion that your technology is better than Hugo. Hugo generates a really static website which can be indexed and search engine optimized.

GiteaMirror commented

@pgaskin commented on GitHub (Jun 1, 2017):

@tboerger @mjwwit @lunny As for my viewer for the docs, it can be made static, but I would prefer Jekyll or a custom script, unless someone else does Hugo. It should be pretty easy to render the docs as completely static pages. Myiewer is not done yet though. Also, my layout makes it easy to switch: it's the pattern Category/Section/Page Title.md. I will continue the docs, but someone else can put together a better site. I just hacked something together quickly to test my docs.

@pgaskin commented on GitHub (Jun 1, 2017): @tboerger @mjwwit @lunny As for my viewer for the docs, it can be made static, but I would prefer Jekyll or a custom script, unless someone else does Hugo. It should be pretty easy to render the docs as completely static pages. Myiewer is not done yet though. Also, my layout makes it easy to switch: it's the pattern `Category/Section/Page Title.md`. I will continue the docs, but someone else can put together a better site. I just hacked something together quickly to test my docs.

GiteaMirror commented

@pgaskin commented on GitHub (Jun 1, 2017):

And for SEO, it is fine, once I put routing in.

@pgaskin commented on GitHub (Jun 1, 2017): And for SEO, it is fine, once I put routing in.

GiteaMirror commented

@pgaskin commented on GitHub (Jun 1, 2017):

Also, @tboerger I never said it was better than Hugo, I said I didn't like Hugo. This could probably be easily made into a static site with almost any generator.

@pgaskin commented on GitHub (Jun 1, 2017): Also, @tboerger I never said it was better than Hugo, I said I didn't like Hugo. This could probably be easily made into a static site with almost any generator.

GiteaMirror commented

@andreynering commented on GitHub (Jun 1, 2017):

@geek1011 Hugo is what most of the team knows. Also, Gitea being written in Go, we give preference for Go tools, and Jekyll uses Ruby. Hugo is also more used for new sites than Jekyll, today.

Improvements to documentation are very welcome! But let's keep our currently tooling that is more than fine. Current docs is at: https://github.com/go-gitea/docs

@andreynering commented on GitHub (Jun 1, 2017): @geek1011 Hugo is what most of the team knows. Also, Gitea being written in Go, we give preference for Go tools, and Jekyll uses Ruby. Hugo is also more used for new sites than Jekyll, today. Improvements to documentation are very welcome! But let's keep our currently tooling that is more than fine. Current docs is at: https://github.com/go-gitea/docs

GiteaMirror commented

@pgaskin commented on GitHub (Jun 1, 2017):

@andreynering ok, your first point is fine. About the existing docs, they need a restructure. IMO, there should be admin docs, user docs, and dev docs. Inside each category, there should be a section, which contains pages.

@pgaskin commented on GitHub (Jun 1, 2017): @andreynering ok, your first point is fine. About the existing docs, they need a restructure. IMO, there should be admin docs, user docs, and dev docs. Inside each category, there should be a section, which contains pages.

GiteaMirror commented

@andreynering commented on GitHub (Jun 1, 2017):

there should be admin docs, user docs, and dev docs. Inside each category, there should be a section, which contains pages.

That makes sense to me.

@andreynering commented on GitHub (Jun 1, 2017): > there should be admin docs, user docs, and dev docs. Inside each category, there should be a section, which contains pages. That makes sense to me.

GiteaMirror commented

@pgaskin commented on GitHub (Jun 1, 2017):

I will learn hugo today, and switch it over. 😃

@pgaskin commented on GitHub (Jun 1, 2017): I will learn hugo today, and switch it over. 😃

GiteaMirror commented