spring-guides / gs-spring-boot

Building an Application with Spring Boot :: Learn how to build an application with minimal configuration.
https://spring.io/guides/gs/spring-boot/
Apache License 2.0
890 stars 4.51k forks source link

adoc links to raw format which is illegible - link to the repo instead #48

Closed mub closed 4 years ago

mub commented 6 years ago

The provided links to the getting-started-macros repo point to the raw format which is unformatted plain text. Link like this instead:

https://github.com/spring-guides/getting-started-macros/blob/master/prereq_editor_jdk_buildtools.adoc

↑ that would provide a →formatted view.

gregturn commented 6 years ago

Again this content is served up on spring.io.

mub commented 6 years ago

@gregturn the links are:

https://raw.githubusercontent.com/... ← that's spring.io :question:

Look, I am offering an easy working solution to make illegible content legible. Why not?

gregturn commented 6 years ago

This entire guide is pulled into Spring.io and through an embedded instance of asciidoctor to render it there. We need the raw version of adoc fragment to properly produce output.

Side effect: doesn’t look at nice here on GitHub.

gregturn commented 6 years ago

Essentially, I would get this at the bottom:

screen shot 2018-06-07 at 12 03 08 pm

Instead of this:

screen shot 2018-06-07 at 12 04 03 pm