Engineering
Releases
News and Events

It's easier than ever to create or contribute to a Getting Started Guide

Greetings Spring community!

We keep receiving feedback that Spring’s Getting Started Guides are smash hit.

So far, we’ve migrated these guides to Asciidoctor. We have also grown our guides to include client-oriented ones. More are coming!

The final link in the chain of making these guides work in the long term are the navigational links in the sidebar of each guide. We are now using metadata to tag and link various guides together while also connecting them to relevant projects.

For example, if you visit Consuming a RESTful Web Service with AngularJS, you will see a sidebar that contains:

The sidebars now require zero maintenance.

Note: If there’s something I’m a fan of, it’s zero maintenance!

If you are making contributions to one of our guides, you no longer have to edit a separate file regarding the sidebar. Instead, each guide is marked up at the top with tags and projects metadata. That is all it takes to build up the navigational links on the sidebars.

This makes it easier than ever to release a new batch of related guides, chained together by some mutual links. For another example, checkout all the Spring Data guides.

When you visit the list of guides, you can do an instant search based on title and guide description, as well as tag. And as you can see by all the links up above, search criteria can be bookmarked, captured, and saved.

FYI: Tag data can change so don’t assume it’s forever.

With all these updates to the way guides are created and managed, the process to create a new one or edit an existing one is simpler than ever.

If you have an idea for a new guide, you can work on it in your own github repository. Just be sure to check out our template project as well as the writing guidelines to see the process for writing, editing, and contributing.

We are eager to see your contributions and will also be spreading the word so that the various Spring leads can write more guides for their projects as well.

comments powered by Disqus