Create a Repository

Create a new private repository at https://github.com/spring-guides. Each GSG lives in its own repository at GitHub under the spring-guides organization. This step requires help from an owner on the spring-guides organization. Name the repo draft-gs-. Ultimately, the “draft” part of the title will be dropped when the new guide is ready to be published. The spring.io web site is designed to look for all gs-* repositories and publish those to the guides section. By initially naming the repository with a draft prefix, spring.io will ignore the repository.

Draft:

draft-gs-rest-service

Published:

gs-rest-service

Configure description

The description field in the repository is used on the spring.io web site to display the title and description for each guide. Edit the description to include the title and description separated by a double colon “::”. This is used by the spring.io web site to parse the two values. Enter the spring.io URL for the guide in the repository website field. Do not include “draft”.

Description format:

<title> :: <description> :: <comma-separated-list-of-projects>

URL:

http://spring.io/guides/gs/rest-service/

Add collaborators

Add committers, administrators, and viewers teams to the repository collaborators.

Add Sagan service hook

Sagan caches rendered guide and evicts cached versions only when notified of changes on the repository. That's why it is required to configure a webhook in the guides repository settings:

• Payload URL: https://spring.io/webhook/docs/guides
• Content type: application/json
• secret: ask @bclozel or @gregturn
• events: Just the push event
• state: Active

Add Slack service hook

In Slack, go to the #sagan-content channel, and type /github subscribe spring-guides/gs-this-guides-name. GitHub will then create the necessary link with the repository.