search

line / armeria

Your go-to microservice framework for any situation, from the creator of Netty et al. You can build any type of microservice leveraging your favorite technologies, including gRPC, Thrift, Kotlin, Retrofit, Reactive Streams, Spring Boot and Dropwizard.
https://armeria.dev
Apache License 2.0
4.82k stars 916 forks source link

Reorganize the web site #2426

Open trustin opened 4 years ago

trustin commented 4 years ago

I'd like to introduce a more user-friendly web site which hosts the following:

Please feel free to let me know if you have anything to add.

anuraaga commented 4 years ago

The IDE integration of stepik is pretty cool but the website (actually it encouraged downloading an app...) seems too heavyweight for tutorials, it's really a courseware platform.

Recommend giving a look at codelabs, I find them pretty easy to create and use.

https://github.com/googlecodelabs/tools https://developers.curioswitch.org/codelabs/writing-a-codelab/#0

trustin commented 4 years ago

codelabs is also an option. I'd like to try both (or more) :-)

trustin commented 4 years ago

Another option would be just to run two Sphinx sites - one for tutorials and the other for references.

trustin commented 4 years ago

What's the difference between CodeLabs and other static site generators? If I understood correctly, a CodeLabs tutorial is basically a Markdown page statically generated by claat. I see there are nicer static site generators that do pretty much same job with more powerful plugins, e.g. VuePress, Docusaurus, Sphinx, ...

anuraaga commented 4 years ago

By the way I only meant for the tutorials.

It's similar to other tools in terms of generation but presents just a small amount of syntax as a tutorial. Some markdown headings get rendered as steps of a tutorial, including e.g., saving step progress in local storage. The lack of power is a feature :)

I looked at docasaurus too before and it looks nice but not for what I really needed, easy to write tutorials. This was 1.5 years ago though maybe there's a good theme for it. Or if not, I'm sure we could come up with a new theme for good rendering of tutorials in other tools too it would just take some effort - but the idea would be to ensure writing tutorials is as easy as possible.

I want to say that it would be good to prioritize writability of content here - amount of documentation for any project is directly proportional to the ease of writing. I find the current Sphinx approach to fall flat on this - the tooling is complicated because of Python (though there are approaches for Gradle to manage Python too, it's not very nice especially on Windows), and the syntax is foreign to almost everyone - this definitely results in reduced documentation. A solution that uses Markdown + (Go or Node) would be nice in this aspect.

syleeeee commented 4 years ago

What about the news? https://spring.io/blog/category/news

It would be great if there's a page to show our recent tweet and upcoming events (+newsletters?).

trustin commented 4 years ago

Nice example from yarn: https://yarnpkg.com/getting-started (Based on Gatsby)

heowc commented 4 years ago

I think it would be very useful if there was also a page like https://start.spring.io. I recently heard that we can create another custom initializr using spring-io/initializr.

Related News: https://spring.io/blog/2020/02/24/netflix-built-a-spring-application-generator-to-boost-dev-productivity-here-s-how-you-can-too

trustin commented 4 years ago

The new web site has been deployed with 0.99.5. 'Guide' and 'Initializer' part still needs to be done.