diff --git a/docs/src/main/asciidoc/dlq.adoc b/docs/src/main/asciidoc/dlq.adoc index 9430a5993..998adffcb 100644 --- a/docs/src/main/asciidoc/dlq.adoc +++ b/docs/src/main/asciidoc/dlq.adoc @@ -33,7 +33,7 @@ If the reason for the dead-lettering is transient, you may wish to route the mes However, if the problem is a permanent issue, that could cause an infinite loop. The sample Spring Boot application within this topic is an example of how to route those messages back to the original topic, but it moves them to a "`parking lot`" topic after three attempts. The application is another spring-cloud-stream application that reads from the dead-letter topic. -It terminates when no messages are received for 5 seconds. +It exits when no messages are received for 5 seconds. The examples assume the original destination is `so8400out` and the consumer group is `so8400`. @@ -115,7 +115,7 @@ public class ReRouteDlqKApplication implements CommandLineRunner { int count = this.processed.get(); Thread.sleep(5000); if (count == this.processed.get()) { - System.out.println("Idle, terminating"); + System.out.println("Idle, exiting"); return; } } diff --git a/docs/src/main/asciidoc/ghpages.sh b/docs/src/main/asciidoc/ghpages.sh index 2562c7171..375ce6c4a 100755 --- a/docs/src/main/asciidoc/ghpages.sh +++ b/docs/src/main/asciidoc/ghpages.sh @@ -4,7 +4,7 @@ set -e # Set default props like MAVEN_PATH, ROOT_FOLDER etc. function set_default_props() { - # The script should be executed from the root folder + # The script should be run from the root folder ROOT_FOLDER=`pwd` echo "Current folder is ${ROOT_FOLDER}" @@ -65,7 +65,7 @@ function build_docs_if_applicable() { } # Get the name of the `docs.main` property -# Get whitelisted branches - assumes that a `docs` module is available under `docs` profile +# Get allowed branches - assumes that a `docs` module is available under `docs` profile function retrieve_doc_properties() { MAIN_ADOC_VALUE=$("${MAVEN_PATH}"mvn -q \ -Dexec.executable="echo" \ @@ -75,14 +75,14 @@ function retrieve_doc_properties() { echo "Extracted 'main.adoc' from Maven build [${MAIN_ADOC_VALUE}]" - WHITELIST_PROPERTY=${WHITELIST_PROPERTY:-"docs.whitelisted.branches"} - WHITELISTED_BRANCHES_VALUE=$("${MAVEN_PATH}"mvn -q \ + ALLOW_PROPERTY=${ALLOW_PROPERTY:-"docs.allowed.branches"} + ALLOWED_BRANCHES_VALUE=$("${MAVEN_PATH}"mvn -q \ -Dexec.executable="echo" \ - -Dexec.args="\${${WHITELIST_PROPERTY}}" \ + -Dexec.args="\${${ALLOW_PROPERTY}}" \ org.codehaus.mojo:exec-maven-plugin:1.3.1:exec \ -P docs \ -pl docs) - echo "Extracted '${WHITELIST_PROPERTY}' from Maven build [${WHITELISTED_BRANCHES_VALUE}]" + echo "Extracted '${ALLOW_PROPERTY}' from Maven build [${ALLOWED_BRANCHES_VALUE}]" } # Stash any outstanding changes @@ -148,9 +148,9 @@ function copy_docs_for_current_version() { else echo -e "Current branch is [${CURRENT_BRANCH}]" # https://stackoverflow.com/questions/29300806/a-bash-script-to-check-if-a-string-is-present-in-a-comma-separated-list-of-strin - if [[ ",${WHITELISTED_BRANCHES_VALUE}," = *",${CURRENT_BRANCH},"* ]] ; then + if [[ ",${ALLOWED_BRANCHES_VALUE}," = *",${CURRENT_BRANCH},"* ]] ; then mkdir -p ${ROOT_FOLDER}/${CURRENT_BRANCH} - echo -e "Branch [${CURRENT_BRANCH}] is whitelisted! Will copy the current docs to the [${CURRENT_BRANCH}] folder" + echo -e "Branch [${CURRENT_BRANCH}] is allowed! Will copy the current docs to the [${CURRENT_BRANCH}] folder" for f in docs/target/generated-docs/*; do file=${f#docs/target/generated-docs/*} if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then @@ -169,7 +169,7 @@ function copy_docs_for_current_version() { done COMMIT_CHANGES="yes" else - echo -e "Branch [${CURRENT_BRANCH}] is not on the white list! Check out the Maven [${WHITELIST_PROPERTY}] property in + echo -e "Branch [${CURRENT_BRANCH}] is not on the allow list! Check out the Maven [${ALLOW_PROPERTY}] property in [docs] module available under [docs] profile. Won't commit any changes to gh-pages for this branch." fi fi @@ -250,10 +250,10 @@ the script will work in the following manner: - if there's no gh-pages / target for docs module then the script ends - for master branch the generated docs are copied to the root of gh-pages branch -- for any other branch (if that branch is whitelisted) a subfolder with branch name is created +- for any other branch (if that branch is allowed) a subfolder with branch name is created and docs are copied there - if the version switch is passed (-v) then a tag with (v) prefix will be retrieved and a folder - with that version number will be created in the gh-pages branch. WARNING! No whitelist verification will take place + with that version number will be created in the gh-pages branch. WARNING! No allow verification will take place - if the destination switch is passed (-d) then the script will check if the provided dir is a git repo and then will switch to gh-pages of that repo and copy the generated docs to `docs//` - if the destination switch is passed (-d) then the script will check if the provided dir is a git repo and then will @@ -327,4 +327,4 @@ build_docs_if_applicable retrieve_doc_properties stash_changes add_docs_from_target -checkout_previous_branch \ No newline at end of file +checkout_previous_branch