SpringCloud/spring-cloud-cli
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #121 from spring-operator/polish-urls-remaining-1.0.x

Browse Source 
URL Cleanup
This commit is contained in:
Ryan Baxter
2019-03-27 11:43:25 -04:00
committed by GitHub
parent a7731737c6 0386082117
commit df09a8ec75
3 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.adoc
View File

@@ -2,7 +2,7 @@
image::https://travis-ci.org/spring-cloud/spring-cloud-cli.svg?branch=master[Build Status, link=https://travis-ci.org/spring-cloud/spring-cloud-cli] image::https://travis-ci.org/spring-cloud/spring-cloud-cli.svg?branch=master[Build Status, link=https://travis-ci.org/spring-cloud/spring-cloud-cli]
Spring Boot CLI provides http://projects.spring.io/spring-boot[Spring Boot] command line features for Spring Boot CLI provides https://projects.spring.io/spring-boot[Spring Boot] command line features for
https://github.com/spring-cloud[Spring Cloud]. You can write Groovy scripts to run Spring Cloud component applications https://github.com/spring-cloud[Spring Cloud]. You can write Groovy scripts to run Spring Cloud component applications
(e.g. `@EnableEurekaServer`). You can also easily do things like encryption and decryption to support Spring Cloud (e.g. `@EnableEurekaServer`). You can also easily do things like encryption and decryption to support Spring Cloud
Config clients with secret configuration values. Config clients with secret configuration values.
@@ -43,7 +43,7 @@ in the JRE lib/security directory with the ones that you downloaded).
=== Basic Compile and Test === Basic Compile and Test
To build the source you will need to install To build the source you will need to install
http://maven.apache.org/run-maven/index.html[Apache Maven] v3.0.6 or above and JDK 1.7. https://maven.apache.org/run-maven/index.html[Apache Maven] v3.0.6 or above and JDK 1.7.
Spring Cloud uses Maven for most build-related activities, and you Spring Cloud uses Maven for most build-related activities, and you
should be able to get off the ground quite quickly by cloning the should be able to get off the ground quite quickly by cloning the
@@ -70,7 +70,7 @@ credentials and you already have those.
If you need mongo, rabbit or redis, see the README in the https://github.com/spring-cloud-samples/scripts[scripts If you need mongo, rabbit or redis, see the README in the https://github.com/spring-cloud-samples/scripts[scripts
demo repository] for demo repository] for
instructions. For example consider using the "fig.yml" with instructions. For example consider using the "fig.yml" with
http://www.fig.sh/[Fig] to run them in Docker containers. https://www.fig.sh/[Fig] to run them in Docker containers.
=== Documentation === Documentation
@@ -109,7 +109,7 @@ added after the original pull request but before a merge.
the ``Importing into eclipse'' instructions below you should get project specific the ``Importing into eclipse'' instructions below you should get project specific
formatting automatically. You can also import formatter settings using the formatting automatically. You can also import formatter settings using the
`eclipse-code-formatter.xml` file from the `eclipse` folder. If using IntelliJ, you can `eclipse-code-formatter.xml` file from the `eclipse` folder. If using IntelliJ, you can
use the http://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter Plugin] use the https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter Plugin]
to import the same file. to import the same file.
* Make sure all new `.java` files to have a simple Javadoc class comment with at least an * Make sure all new `.java` files to have a simple Javadoc class comment with at least an
`@author` tag identifying you, and preferably at least a paragraph on what the class is `@author` tag identifying you, and preferably at least a paragraph on what the class is
@@ -125,13 +125,13 @@ added after the original pull request but before a merge.
=== Working with the code === Working with the code
If you don't have an IDE preference we would recommend that you use If you don't have an IDE preference we would recommend that you use
http://www.springsource.com/developer/sts[Spring Tools Suite] or https://www.springsource.com/developer/sts[Spring Tools Suite] or
http://eclipse.org[Eclipse] when working with the code. We use the https://eclipse.org[Eclipse] when working with the code. We use the
http://eclipse.org/m2e/[m2eclipe] eclipse plugin for maven support. Other IDEs and tools https://eclipse.org/m2e/[m2eclipe] eclipse plugin for maven support. Other IDEs and tools
should also work without issue. should also work without issue.
==== Importing into eclipse with m2eclipse ==== Importing into eclipse with m2eclipse
We recommend the http://eclipse.org/m2e/[m2eclipe] eclipse plugin when working with We recommend the https://eclipse.org/m2e/[m2eclipe] eclipse plugin when working with
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
marketplace". marketplace".
@@ -150,7 +150,7 @@ from the `file` menu.
==== Adding Project Lombok Agent ==== Adding Project Lombok Agent
Spring Cloud uses [Project Spring Cloud uses [Project
Lombok](http://projectlombok.org/features/index.html) to generate Lombok](https://projectlombok.org/features/index.html) to generate
getters and setters etc. Compiling from the command line this getters and setters etc. Compiling from the command line this
shouldn't cause any problems, but in an IDE you need to add an agent shouldn't cause any problems, but in an IDE you need to add an agent
to the JVM. Full instructions can be found in the Lombok website. The to the JVM. Full instructions can be found in the Lombok website. The
@@ -193,7 +193,7 @@ added after the original pull request but before a merge.
`eclipse-code-formatter.xml` file from the `eclipse-code-formatter.xml` file from the
https://github.com/spring-cloud/build/tree/master/eclipse-coding-conventions.xml[Spring https://github.com/spring-cloud/build/tree/master/eclipse-coding-conventions.xml[Spring
Cloud Build] project. If using IntelliJ, you can use the Cloud Build] project. If using IntelliJ, you can use the
http://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter
Plugin] to import the same file. Plugin] to import the same file.
* Make sure all new `.java` files to have a simple Javadoc class comment with at least an * Make sure all new `.java` files to have a simple Javadoc class comment with at least an
`@author` tag identifying you, and preferably at least a paragraph on what the class is `@author` tag identifying you, and preferably at least a paragraph on what the class is
@@ -206,6 +206,6 @@ added after the original pull request but before a merge.
* A few unit tests would help a lot as well -- someone has to do it. * A few unit tests would help a lot as well -- someone has to do it.
* If no-one else is using your branch, please rebase it against the current master (or * If no-one else is using your branch, please rebase it against the current master (or
other target branch in the main project). other target branch in the main project).
* When writing a commit message please follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], * When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions],
if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit
message (where XXXX is the issue number). message (where XXXX is the issue number).

2
docs/README.adoc
View File

@@ -24,7 +24,7 @@ $ gvm use springboot 1.1.5.RELEASE
then get the install command plugin (backported from Boot 1.2.0): then get the install command plugin (backported from Boot 1.2.0):
``` ```
$ wget http://dl.bintray.com/dsyer/generic/install-0.0.1.jar $ wget https://dl.bintray.com/dsyer/generic/install-0.0.1.jar
``` ```
install it in the Spring Boot CLI, e.g. with GVM (MacOS users that rely on brew might have to find the `/lib` directory by scanning `brew info springboot`): install it in the Spring Boot CLI, e.g. with GVM (MacOS users that rely on brew might have to find the `/lib` directory by scanning `brew info springboot`):

2
docs/src/main/asciidoc/intro.adoc
View File

@@ -1,4 +1,4 @@
Spring Boot CLI provides http://projects.spring.io/spring-boot[Spring Boot] command line features for Spring Boot CLI provides https://projects.spring.io/spring-boot[Spring Boot] command line features for
https://github.com/spring-cloud[Spring Cloud]. You can write Groovy scripts to run Spring Cloud component applications https://github.com/spring-cloud[Spring Cloud]. You can write Groovy scripts to run Spring Cloud component applications
(e.g. `@EnableEurekaServer`). You can also easily do things like encryption and decryption to support Spring Cloud (e.g. `@EnableEurekaServer`). You can also easily do things like encryption and decryption to support Spring Cloud
Config clients with secret configuration values. Config clients with secret configuration values.