Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use HTTPS for external links where possible

Browse Source 
See gh-609
This commit is contained in:
Spring Operator
2019-03-26 04:42:31 -05:00
committed by Andy Wilkinson
parent 4fdb1f5361
commit f2e60ea347
25 changed files with 52 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/src/docs/asciidoc/contributing.adoc
View File

@@ -9,7 +9,7 @@ for your RESTful services. However, we can't achieve that goal without your cont
[[contributing-questions]]
=== Questions
You can ask questions about Spring REST Docs on http://stackoverflow.com[StackOverflow]
You can ask questions about Spring REST Docs on https://stackoverflow.com[StackOverflow]
using the `spring-restdocs` tag. Similarly, we encourage you to help your fellow
Spring REST Docs users by answering questions.

2
docs/src/docs/asciidoc/documenting-your-api.adoc
View File

@@ -444,7 +444,7 @@ A number of snippets are produced automatically when you document a call to
|Snippet | Description
| `curl-request.adoc`
| Contains the http://curl.haxx.se[`curl`] command that is equivalent to the `MockMvc`
| Contains the https://curl.haxx.se[`curl`] command that is equivalent to the `MockMvc`
call that is being documented
| `http-request.adoc`

6
docs/src/docs/asciidoc/getting-started.adoc
View File

@@ -10,9 +10,9 @@ This section describes how to get started with Spring REST Docs.
If you want to jump straight in, there are two sample applications available.
{samples}/rest-notes-spring-hateoas[One sample] uses
http://projects.spring.io/spring-hateoas/[Spring HATEOAS] and
https://projects.spring.io/spring-hateoas/[Spring HATEOAS] and
{samples}/rest-notes-spring-data-rest[the other] uses
http://projects.spring.io/spring-data-rest/[Spring Data REST]. Both samples use
https://projects.spring.io/spring-data-rest/[Spring Data REST]. Both samples use
Spring REST Docs to produce a detailed API guide and a getting started walkthrough.
Each sample contains a file named `api-guide.adoc` that produces an API guide for the
@@ -295,7 +295,7 @@ that can be produced by Spring REST Docs.
=== Using the snippets
The generated snippets can be included in your documentation using the
http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include macro].
https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include macro].
The `snippets` attribute specified in the <<getting-started-build-configuration, build
configuration>> can be used to reference the snippets output directory. For example:

4
docs/src/docs/asciidoc/index.adoc
View File

@@ -12,8 +12,8 @@ Andy Wilkinson
:source: {github}/tree/{branch-or-tag}
:samples: {source}/samples
:templates: {source}spring-restdocs/src/main/resources/org/springframework/restdocs/templates
:spring-boot-docs: http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle
:spring-framework-docs: http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle
:spring-framework-docs: https://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle
[[abstract]]

2
docs/src/docs/asciidoc/introduction.adoc
View File

@@ -6,7 +6,7 @@ services that is accurate and readable.
Writing high-quality documentation is difficult. One way to ease that difficulty is to use
tools that are well-suited to the job. To this end, Spring REST Docs uses
http://asciidoctor.org[Asciidoctor]. Asciidoctor processes plain text and produces
https://asciidoctor.org[Asciidoctor]. Asciidoctor processes plain text and produces
HTML, styled and layed out to suit your needs.
Spring REST Docs makes use of snippets produced by tests written with

10
docs/src/docs/asciidoc/working-with-asciidoctor.adoc
View File

@@ -9,15 +9,15 @@ relevant to Spring REST Docs.
[[working-with-asciidoctor-resources]]
=== Resources
* http://asciidoctor.org/docs/asciidoc-syntax-quick-reference[Syntax quick reference]
* http://asciidoctor.org/docs/user-manual[User manual]
* https://asciidoctor.org/docs/asciidoc-syntax-quick-reference[Syntax quick reference]
* https://asciidoctor.org/docs/user-manual[User manual]
[[working-with-asciidoctor-including-snippets]]
=== Including snippets
The http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include
The https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include
macro] is used to include generated snippets in your documentation. The `snippets`
attribute specified in the <<getting-started-build-configuration, build configuration>>
can be used to reference the snippets output directory, for example:
@@ -42,7 +42,7 @@ snippet is included or by using a custom snippet template.
==== Formatting columns
Asciidoctor has rich support for
http://asciidoctor.org/docs/user-manual/#cols-format[formatting a table's columns]. For
https://asciidoctor.org/docs/user-manual/#cols-format[formatting a table's columns]. For
example, the widths of a table's columns can be specified using the `cols` attribute:
[source,adoc,indent=0]
@@ -71,5 +71,5 @@ The title of a table can be specified using a line prefixed by a `.`:
==== Further reading
Refer to the http://asciidoctor.org/docs/user-manual/#tables[Tables section of
Refer to the https://asciidoctor.org/docs/user-manual/#tables[Tables section of
the Asciidoctor user manual] for more information about customizing tables.