Commit Graph

50 Commits

Author SHA1 Message Date
Janne Valkealahti
4e625feb03 Drop jcommander
- Fixes #395
2022-04-29 15:55:21 +01:00
Janne Valkealahti
942108e612 Update docs
- Split adoc files
- Relates #383
2022-04-23 08:36:10 +01:00
Janne Valkealahti
8920db699d Update component docs
- Relates #361
2022-02-24 09:25:38 +00:00
Janne Valkealahti
547e82ab93 Fix highlight in docs 2022-02-24 09:23:35 +00:00
Janne Valkealahti
1593ee86d2 Update docs
- Polish pom
- Version command
- Theming
- Templating
- Relates #354
2022-02-03 09:51:13 +00:00
Janne Valkealahti
3197c94be7 Switch main from 3.0.0-SNAPSHOT to 2.1.0-SNAPSHOT
- Relates #356
2022-01-28 09:27:06 +00:00
Janne Valkealahti
e8a42e0633 Fix javadoc publish
- Attempt to get api docs into static bundle.
- Relates #351
2022-01-23 15:10:37 +00:00
Janne Valkealahti
cde73ec2c0 Update docs 2022-01-21 09:28:22 +00:00
Janne Valkealahti
6c2e858534 Fix docs copyright year 2022-01-18 13:23:56 +00:00
Janne Valkealahti
5dcdc4c185 Extract autoconfig
- Create separate spring-shell-autoconfigure and keep
  all autoconfig features there.
- Fixes #329
2021-12-19 12:38:41 +00:00
Janne Valkealahti
d26f6d1a90 Update doc authors 2021-12-18 13:01:58 +00:00
Johnny Marnell
2b7a9b15e6 Clarify how to achieve varying arity in docs
Add examples of how to achieve, with existing functionality, a varying amount of parameter arity (and favor this verbage over "infinite", which, though technically true, could be misleading for evoking neding a very large amount of a parameter, instead of the normal usecase of a few of any amount).
2021-12-18 12:54:06 +00:00
Jay Bryant
012481ef63 Update document appearance
Use Spring's standard styles for the ToC. Also added epub generation.
2021-12-18 09:29:09 +00:00
Jay Bryant
7473c9ec5c Editing pass
Edited for spelling, puncuation, grammar, usage, and corporate voice.
2021-12-18 08:13:47 +00:00
Janne Valkealahti
1dd2706164 Make build work with jdk 11/17
- Fixes #326
2021-12-17 16:15:38 +00:00
Janne Valkealahti
90216bdc32 Switch from BUILD-SNAPSHOT to SNAPSHOT 2021-12-17 14:25:52 +00:00
Janne Valkealahti
ee849d1aa8 Update plugin versions 2021-12-11 09:02:38 +00:00
Gao Liang
10fb9a8ed2 fix pom exclusions 2021-12-11 08:41:45 +00:00
Jay Bryant
eca0dd1572 Update doc appearance and link doc formats
Updated the ToC, banner, highlighting, and CSS styles to the last Spring standard.
Linked the HTML output to the PDF output and vice-versa.
2021-12-11 08:39:05 +00:00
onnadi-sa
296db93462 Fix typo 2019-10-02 12:02:13 +02:00
Spring Operator
23d99f45eb URL Cleanup
This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener).

# HTTP URLs that Could Not Be Fixed
These URLs were unable to be fixed. Please review them to see if they can be manually resolved.

* http://jcommander.org/apidocs/ (200) with 1 occurrences could not be migrated:
   ([https](https://jcommander.org/apidocs/) result SSLHandshakeException).

# Fixed URLs

## Fixed Success
These URLs were switched to an https URL with a 2xx status. While the status was successful, your review is still recommended.

* http://docs.spring.io/spring-framework/docs/current/javadoc-api/ with 1 occurrences migrated to:
  https://docs.spring.io/spring-framework/docs/current/javadoc-api/ ([https](https://docs.spring.io/spring-framework/docs/current/javadoc-api/) result 200).
* http://maven.apache.org/xsd/assembly-2.0.0.xsd with 1 occurrences migrated to:
  https://maven.apache.org/xsd/assembly-2.0.0.xsd ([https](https://maven.apache.org/xsd/assembly-2.0.0.xsd) result 200).
* http://maven.apache.org/xsd/maven-4.0.0.xsd with 12 occurrences migrated to:
  https://maven.apache.org/xsd/maven-4.0.0.xsd ([https](https://maven.apache.org/xsd/maven-4.0.0.xsd) result 200).
* http://repo.spring.io/libs-milestone-local with 2 occurrences migrated to:
  https://repo.spring.io/libs-milestone-local ([https](https://repo.spring.io/libs-milestone-local) result 302).
* http://repo.spring.io/libs-snapshot-local with 2 occurrences migrated to:
  https://repo.spring.io/libs-snapshot-local ([https](https://repo.spring.io/libs-snapshot-local) result 302).
* http://repo.spring.io/release with 1 occurrences migrated to:
  https://repo.spring.io/release ([https](https://repo.spring.io/release) result 302).

# Ignored
These URLs were intentionally ignored.

* http://maven.apache.org/ASSEMBLY/2.0.0 with 2 occurrences
* http://maven.apache.org/POM/4.0.0 with 24 occurrences
* http://www.w3.org/2001/XMLSchema-instance with 13 occurrences
2019-03-26 11:55:46 +01:00
Spring Operator
7176450689 URL Cleanup
This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener).

# Fixed URLs

## Fixed Success
These URLs were switched to an https URL with a 2xx status. While the status was successful, your review is still recommended.

* [ ] http://beanvalidation.org/ with 1 occurrences migrated to:
  https://beanvalidation.org/ ([https](https://beanvalidation.org/) result 200).
* [ ] http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/ with 1 occurrences migrated to:
  https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/ ([https](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/) result 200).
* [ ] http://github.com/spring-projects/spring-shell with 1 occurrences migrated to:
  https://github.com/spring-projects/spring-shell ([https](https://github.com/spring-projects/spring-shell) result 200).
* [ ] http://start.spring.io with 2 occurrences migrated to:
  https://start.spring.io ([https](https://start.spring.io) result 200).
* [ ] http://www.java.com/en/download/help/error_hotspot.xml with 1 occurrences migrated to:
  https://www.java.com/en/download/help/error_hotspot.xml ([https](https://www.java.com/en/download/help/error_hotspot.xml) result 200).
* [ ] http://contributor-covenant.org with 1 occurrences migrated to:
  https://contributor-covenant.org ([https](https://contributor-covenant.org) result 301).
* [ ] http://contributor-covenant.org/version/1/3/0/ with 1 occurrences migrated to:
  https://contributor-covenant.org/version/1/3/0/ ([https](https://contributor-covenant.org/version/1/3/0/) result 301).
2019-03-26 11:48:55 +01:00
Spring Operator
658aba2785 URL Cleanup
This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener).

# HTTP URLs that Could Not Be Fixed
These URLs were unable to be fixed. Please review them to see if they can be manually resolved.

* http://jcommander.org/apidocs/ (200) migrated to:
  http://jcommander.org/apidocs/ ([https](https://jcommander.org/apidocs/) result SSLHandshakeException).

# Fixed URLs

## Fixed Success
These URLs were fixed successfully.

* http://docs.spring.io/spring-framework/docs/current/javadoc-api/ migrated to:
  https://docs.spring.io/spring-framework/docs/current/javadoc-api/ ([https](https://docs.spring.io/spring-framework/docs/current/javadoc-api/) result 200).
* http://www.apache.org/licenses/LICENSE-2.0 migrated to:
  https://www.apache.org/licenses/LICENSE-2.0 ([https](https://www.apache.org/licenses/LICENSE-2.0) result 200).
* http://repo.spring.io/libs-milestone-local migrated to:
  https://repo.spring.io/libs-milestone-local ([https](https://repo.spring.io/libs-milestone-local) result 302).
* http://repo.spring.io/libs-snapshot-local migrated to:
  https://repo.spring.io/libs-snapshot-local ([https](https://repo.spring.io/libs-snapshot-local) result 302).
* http://repo.spring.io/release migrated to:
  https://repo.spring.io/release ([https](https://repo.spring.io/release) result 302).

# Ignored
These URLs were intentionally ignored.

* http://maven.apache.org/POM/4.0.0
* http://maven.apache.org/xsd/maven-4.0.0.xsd
* http://www.w3.org/2001/XMLSchema-instance
2019-03-26 11:46:51 +01:00
Janne Valkealahti
31c7462ee3 Change to boot 2.x
- disable PropertyPlaceholderAutoConfiguration in NoAutoConf
- Remove shell1 deps
- Update README
2018-11-14 12:16:30 +00:00
Janne Valkealahti
4f0dc203af Change to next major development version 3.0.0 2018-11-14 09:11:34 +00:00
Spring Buildmaster
75b9c2c846 [artifactory-release] Next development version 2018-04-25 08:29:26 +00:00
Spring Buildmaster
f39c391342 [artifactory-release] Release version 2.0.1.RELEASE 2018-04-25 08:29:21 +00:00
Florian Waibel
793eaa6fe7 Fix method annotation in some reference documentation snippets
Somehow `@ShellCommand` found its way into the snippets. This commit
replaces it with the correct annotation `@ShellMethod`.
2018-01-17 21:31:07 +01:00
Spring Buildmaster
ded7b756b1 [artifactory-release] Next development version 2018-01-16 09:01:03 +00:00
Spring Buildmaster
a6ecde1406 [artifactory-release] Release version 2.0.0.RELEASE 2018-01-16 09:00:58 +00:00
Eric Bottard
f90edd42c4 Make ResultHandlers configuration more explicit
Handle exit as a dedicated case (prevents eg 'exit' commands in scripts to make script quit)
Add an example of custom ApplicationRunner

Fixes #187
Fixes #183

Decouple ApplicationRunners

Make ThrowableResultHandler behave differently in non-interactive mode
2018-01-15 15:59:01 +01:00
Eric Bottard
2ef0610f81 Added an example of full class dynamic availability toggle
Fixes #175
2017-11-06 15:12:46 +01:00
Eric Bottard
7d50c0813f Qualify the Spring Shell provided ConversionService
Fixes #173
2017-11-06 14:52:50 +01:00
Eric Bottard
91bc5f31e7 Warn about potential NPE when using gradle 2017-10-09 09:56:11 +02:00
Spring Buildmaster
e917d876e3 [artifactory-release] Next development version 2017-10-04 09:29:34 +00:00
Spring Buildmaster
1bea66cdb1 [artifactory-release] Release version 2.0.0.M2 2017-10-04 09:29:29 +00:00
Eric Bottard
f0e5c45ee9 Add automatic command grouping
Fixes #163

Introduce Command and Command.Help
2017-09-28 09:44:48 +02:00
altus34
1695527408 Fix documentation
- Optional Parameters and Default Values. Type error in greet method signature who cause compile error
 - Customizing the Named Parameter Key(s). help method is already registered in spring shell by default and cannot be reused
2017-09-23 10:57:13 +02:00
Eric Bottard
a50b741af1 Document PromptProvider, ApplicationRunner and ConversionService.
Make the default ConversionService register converters in the ctx
2017-09-19 13:57:28 +02:00
Eric Bottard
b9df6c48a9 Small docs fixes 2017-09-18 19:01:09 +02:00
Spring Buildmaster
425493e0a9 [artifactory-release] Next development version 2017-09-14 14:29:28 +00:00
Spring Buildmaster
ccd2444b1e [artifactory-release] Release version 2.0.0.M1 2017-09-14 14:29:24 +00:00
Eric Bottard
919cefbc52 Document bean validation 2017-09-07 14:48:50 +02:00
Eric Bottard
49850562c1 Generate aggregated API docs
Fixes #145
2017-08-29 17:44:27 +02:00
Eric Bottard
dfa1a778a5 More reference documentation 2017-08-28 15:32:37 +02:00
Eric Bottard
be1603214d More reference documentation 2017-08-25 18:16:09 +02:00
Eric Bottard
56adc9ab5a Write tutorial in ref doc 2017-08-23 21:09:40 +02:00
Eric Bottard
1eea04ad2f Add dynamic command availability
Introduce availability concept on MethodTarget (with reason if not available)
Add bridge to @CliAvailabilityIndicator to Legacy registrar

Fixes #138

Add help for unavailable commands

Add standard API for availability
2017-08-23 18:44:31 +02:00
Eric Bottard
51c043e1e1 Remove extra directory in docs zip 2017-08-18 14:00:33 +02:00
Eric Bottard
3fb368476f Add Reference Documentation infrastructure 2017-08-17 12:22:52 +02:00