diff --git a/.github/workflows/updateDocs.yaml b/.github/workflows/updateDocs.yaml index 0ba2926b..aa0a529e 100644 --- a/.github/workflows/updateDocs.yaml +++ b/.github/workflows/updateDocs.yaml @@ -4,15 +4,24 @@ on: push: branches: - main - - hotfix/* + - docs + - 4.* + # paths: + # - 'docs/**' + # release: + # types: [published] # includes pre-release and regular releases, but does not include draft releases. + # workflow_dispatch: + # inputs: + # committish: + # description: Tag or branch of the docs to be created or updated. Using `main` will update the landing page. Using anything else will create or update a versioned copy of the docs. + # required: true + # default: main jobs: updateDocs: runs-on: ubuntu-20.04 steps: - - - name: Install azure-sdk-for-java - run: | + - run: | git init azure-sdk-for-java cd azure-sdk-for-java git remote add origin https://github.com/Azure/azure-sdk-for-java.git @@ -30,15 +39,11 @@ jobs: -Dparallel-test-playback \ -Pdev \ -f sdk/spring/pom.xml - - name: Get current date id: date run: echo "::set-output name=date::$(date +'%Y-%m-%d' --utc)" - - uses: actions/checkout@v2 - - - name: Config git - run: | + - run: | git config user.name github-actions git config user.email github-actions@github.com @@ -57,5 +62,28 @@ jobs: if: steps.mvn-cache.outputs.cache-hit != 'true' run: ./mvnw compile dependency:go-offline + - name: Mvn install # Need this when the version/directory/pom structure changes + run: | + ./mvnw \ + --batch-mode \ + --show-version \ + --threads 1.5C \ + --define maven.test.skip=true \ + --define maven.javadoc.skip=true \ + install + + - name: Remove SNAPSHOT # Needed for releases + run: | + if [[ -n "${{ github.event.release.tag_name }}" ]] ; then + ./mvnw versions:set --batch-mode -DremoveSnapshot -DprocessAllModules + fi + - name: Update Docs - run: ./scripts/update_gh-pages_branch.sh --build + run: | + if [[ -n "${{ github.event.release.tag_name }}" ]] ; then + ./docs/src/main/asciidoc/ghpages.sh --version ${{ github.event.release.tag_name }} --destination . --build + elif [[ -n "${{ github.event.inputs.committish }}" ]] && [[ "${{ github.event.inputs.committish }}" != "main" ]] ; then + ./docs/src/main/asciidoc/ghpages.sh --version ${{ github.event.inputs.committish }} --destination . --build + else + ./docs/src/main/asciidoc/ghpages.sh --build + fi diff --git a/getting-started/.vale-styles/Microsoft/AMPM.yml b/docs/.vale-styles/Microsoft/AMPM.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/AMPM.yml rename to docs/.vale-styles/Microsoft/AMPM.yml diff --git a/getting-started/.vale-styles/Microsoft/Accessibility.yml b/docs/.vale-styles/Microsoft/Accessibility.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Accessibility.yml rename to docs/.vale-styles/Microsoft/Accessibility.yml diff --git a/getting-started/.vale-styles/Microsoft/Acronyms.yml b/docs/.vale-styles/Microsoft/Acronyms.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Acronyms.yml rename to docs/.vale-styles/Microsoft/Acronyms.yml diff --git a/getting-started/.vale-styles/Microsoft/Adverbs.yml b/docs/.vale-styles/Microsoft/Adverbs.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Adverbs.yml rename to docs/.vale-styles/Microsoft/Adverbs.yml diff --git a/getting-started/.vale-styles/Microsoft/Auto.yml b/docs/.vale-styles/Microsoft/Auto.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Auto.yml rename to docs/.vale-styles/Microsoft/Auto.yml diff --git a/getting-started/.vale-styles/Microsoft/Avoid.yml b/docs/.vale-styles/Microsoft/Avoid.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Avoid.yml rename to docs/.vale-styles/Microsoft/Avoid.yml diff --git a/getting-started/.vale-styles/Microsoft/ComplexWords.yml b/docs/.vale-styles/Microsoft/ComplexWords.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/ComplexWords.yml rename to docs/.vale-styles/Microsoft/ComplexWords.yml diff --git a/getting-started/.vale-styles/Microsoft/Contractions.yml b/docs/.vale-styles/Microsoft/Contractions.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Contractions.yml rename to docs/.vale-styles/Microsoft/Contractions.yml diff --git a/getting-started/.vale-styles/Microsoft/Dashes.yml b/docs/.vale-styles/Microsoft/Dashes.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Dashes.yml rename to docs/.vale-styles/Microsoft/Dashes.yml diff --git a/getting-started/.vale-styles/Microsoft/DateFormat.yml b/docs/.vale-styles/Microsoft/DateFormat.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/DateFormat.yml rename to docs/.vale-styles/Microsoft/DateFormat.yml diff --git a/getting-started/.vale-styles/Microsoft/DateNumbers.yml b/docs/.vale-styles/Microsoft/DateNumbers.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/DateNumbers.yml rename to docs/.vale-styles/Microsoft/DateNumbers.yml diff --git a/getting-started/.vale-styles/Microsoft/DateOrder.yml b/docs/.vale-styles/Microsoft/DateOrder.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/DateOrder.yml rename to docs/.vale-styles/Microsoft/DateOrder.yml diff --git a/getting-started/.vale-styles/Microsoft/Ellipses.yml b/docs/.vale-styles/Microsoft/Ellipses.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Ellipses.yml rename to docs/.vale-styles/Microsoft/Ellipses.yml diff --git a/getting-started/.vale-styles/Microsoft/FirstPerson.yml b/docs/.vale-styles/Microsoft/FirstPerson.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/FirstPerson.yml rename to docs/.vale-styles/Microsoft/FirstPerson.yml diff --git a/getting-started/.vale-styles/Microsoft/Foreign.yml b/docs/.vale-styles/Microsoft/Foreign.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Foreign.yml rename to docs/.vale-styles/Microsoft/Foreign.yml diff --git a/getting-started/.vale-styles/Microsoft/Gender.yml b/docs/.vale-styles/Microsoft/Gender.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Gender.yml rename to docs/.vale-styles/Microsoft/Gender.yml diff --git a/getting-started/.vale-styles/Microsoft/GenderBias.yml b/docs/.vale-styles/Microsoft/GenderBias.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/GenderBias.yml rename to docs/.vale-styles/Microsoft/GenderBias.yml diff --git a/getting-started/.vale-styles/Microsoft/GeneralURL.yml b/docs/.vale-styles/Microsoft/GeneralURL.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/GeneralURL.yml rename to docs/.vale-styles/Microsoft/GeneralURL.yml diff --git a/getting-started/.vale-styles/Microsoft/HeadingAcronyms.yml b/docs/.vale-styles/Microsoft/HeadingAcronyms.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/HeadingAcronyms.yml rename to docs/.vale-styles/Microsoft/HeadingAcronyms.yml diff --git a/getting-started/.vale-styles/Microsoft/HeadingColons.yml b/docs/.vale-styles/Microsoft/HeadingColons.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/HeadingColons.yml rename to docs/.vale-styles/Microsoft/HeadingColons.yml diff --git a/getting-started/.vale-styles/Microsoft/HeadingPunctuation.yml b/docs/.vale-styles/Microsoft/HeadingPunctuation.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/HeadingPunctuation.yml rename to docs/.vale-styles/Microsoft/HeadingPunctuation.yml diff --git a/getting-started/.vale-styles/Microsoft/Headings.yml b/docs/.vale-styles/Microsoft/Headings.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Headings.yml rename to docs/.vale-styles/Microsoft/Headings.yml diff --git a/getting-started/.vale-styles/Microsoft/Hyphens.yml b/docs/.vale-styles/Microsoft/Hyphens.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Hyphens.yml rename to docs/.vale-styles/Microsoft/Hyphens.yml diff --git a/getting-started/.vale-styles/Microsoft/Negative.yml b/docs/.vale-styles/Microsoft/Negative.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Negative.yml rename to docs/.vale-styles/Microsoft/Negative.yml diff --git a/getting-started/.vale-styles/Microsoft/Ordinal.yml b/docs/.vale-styles/Microsoft/Ordinal.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Ordinal.yml rename to docs/.vale-styles/Microsoft/Ordinal.yml diff --git a/getting-started/.vale-styles/Microsoft/OxfordComma.yml b/docs/.vale-styles/Microsoft/OxfordComma.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/OxfordComma.yml rename to docs/.vale-styles/Microsoft/OxfordComma.yml diff --git a/getting-started/.vale-styles/Microsoft/Passive.yml b/docs/.vale-styles/Microsoft/Passive.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Passive.yml rename to docs/.vale-styles/Microsoft/Passive.yml diff --git a/getting-started/.vale-styles/Microsoft/Percentages.yml b/docs/.vale-styles/Microsoft/Percentages.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Percentages.yml rename to docs/.vale-styles/Microsoft/Percentages.yml diff --git a/getting-started/.vale-styles/Microsoft/Quotes.yml b/docs/.vale-styles/Microsoft/Quotes.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Quotes.yml rename to docs/.vale-styles/Microsoft/Quotes.yml diff --git a/getting-started/.vale-styles/Microsoft/RangeFormat.yml b/docs/.vale-styles/Microsoft/RangeFormat.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/RangeFormat.yml rename to docs/.vale-styles/Microsoft/RangeFormat.yml diff --git a/getting-started/.vale-styles/Microsoft/RangeTime.yml b/docs/.vale-styles/Microsoft/RangeTime.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/RangeTime.yml rename to docs/.vale-styles/Microsoft/RangeTime.yml diff --git a/getting-started/.vale-styles/Microsoft/Ranges.yml b/docs/.vale-styles/Microsoft/Ranges.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Ranges.yml rename to docs/.vale-styles/Microsoft/Ranges.yml diff --git a/getting-started/.vale-styles/Microsoft/Semicolon.yml b/docs/.vale-styles/Microsoft/Semicolon.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Semicolon.yml rename to docs/.vale-styles/Microsoft/Semicolon.yml diff --git a/getting-started/.vale-styles/Microsoft/SentenceLength.yml b/docs/.vale-styles/Microsoft/SentenceLength.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/SentenceLength.yml rename to docs/.vale-styles/Microsoft/SentenceLength.yml diff --git a/getting-started/.vale-styles/Microsoft/Spacing.yml b/docs/.vale-styles/Microsoft/Spacing.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Spacing.yml rename to docs/.vale-styles/Microsoft/Spacing.yml diff --git a/getting-started/.vale-styles/Microsoft/Suspended.yml b/docs/.vale-styles/Microsoft/Suspended.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Suspended.yml rename to docs/.vale-styles/Microsoft/Suspended.yml diff --git a/getting-started/.vale-styles/Microsoft/Terms.yml b/docs/.vale-styles/Microsoft/Terms.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Terms.yml rename to docs/.vale-styles/Microsoft/Terms.yml diff --git a/getting-started/.vale-styles/Microsoft/URLFormat.yml b/docs/.vale-styles/Microsoft/URLFormat.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/URLFormat.yml rename to docs/.vale-styles/Microsoft/URLFormat.yml diff --git a/getting-started/.vale-styles/Microsoft/Units.yml b/docs/.vale-styles/Microsoft/Units.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Units.yml rename to docs/.vale-styles/Microsoft/Units.yml diff --git a/getting-started/.vale-styles/Microsoft/Vocab.yml b/docs/.vale-styles/Microsoft/Vocab.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Vocab.yml rename to docs/.vale-styles/Microsoft/Vocab.yml diff --git a/getting-started/.vale-styles/Microsoft/We.yml b/docs/.vale-styles/Microsoft/We.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/We.yml rename to docs/.vale-styles/Microsoft/We.yml diff --git a/getting-started/.vale-styles/Microsoft/Wordiness.yml b/docs/.vale-styles/Microsoft/Wordiness.yml similarity index 100% rename from getting-started/.vale-styles/Microsoft/Wordiness.yml rename to docs/.vale-styles/Microsoft/Wordiness.yml diff --git a/getting-started/.vale-styles/Microsoft/meta.json b/docs/.vale-styles/Microsoft/meta.json similarity index 100% rename from getting-started/.vale-styles/Microsoft/meta.json rename to docs/.vale-styles/Microsoft/meta.json diff --git a/getting-started/.vale.ini b/docs/.vale.ini similarity index 100% rename from getting-started/.vale.ini rename to docs/.vale.ini diff --git a/getting-started/README.adoc b/docs/README.adoc similarity index 100% rename from getting-started/README.adoc rename to docs/README.adoc diff --git a/docs/generate-docs.sh b/docs/generate-docs.sh new file mode 100755 index 00000000..c2ba12b2 --- /dev/null +++ b/docs/generate-docs.sh @@ -0,0 +1,6 @@ +#!/bin/bash -x + +# This command regenerates the docs after editing. +# You'll have to run this after editing the src/main/asciidoc/README.adoc + +mvn clean install -Pdocs diff --git a/docs/pom.xml b/docs/pom.xml new file mode 100644 index 00000000..581ba83c --- /dev/null +++ b/docs/pom.xml @@ -0,0 +1,308 @@ + + + 4.0.0 + + + com.azure.spring + spring-cloud-azure-aggregator + 4.1.0-beta.1 + ../pom.xml + + + spring-cloud-azure-build-docs + spring-cloud-azure-build-docs + jar + Spring Cloud Azure Build Docs + + + spring-cloud-azure + ${basedir}/.. + ${project.version} + none + ${project.build.directory}/generated-docs/${project.version}/reference/html + ${project.build.directory}/generated-docs/${project.version}/reference/htmlsingle + ${project.build.directory}/generated-docs/${project.version}/reference/pdf + + + + spring-milestones + Spring Milestones + https://repo.spring.io/milestone + + false + + + + spring-releases + Spring Releases + https://repo.spring.io/release + + false + + + + + + spring-milestones + Spring Milestones + https://repo.spring.io/milestone + + false + + + + spring-releases + Spring Releases + https://repo.spring.io/release + + false + + + + + + com.azure.spring + spring-cloud-azure-starter + + + com.azure.spring + spring-cloud-azure-starter-stream-eventhubs + + + com.azure.spring + spring-cloud-azure-starter-stream-servicebus + + + + + + maven-deploy-plugin + + true + + + + + + + docs + + + + pl.project13.maven + git-commit-id-plugin + + + org.apache.maven.plugins + maven-dependency-plugin + + + org.apache.maven.plugins + maven-resources-plugin + + + org.codehaus.mojo + exec-maven-plugin + + + generate-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops.adoc + spring.jms.servicebus.*|spring.cloud.azure.* + + + + + generate-global-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_global.adoc + spring.cloud.azure.(client|credential|profile|proxy|retry).* + + + + + generate-aad-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_aad.adoc + spring.cloud.azure.active-directory.* + + + + + generate-aadb2c-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_aadb2c.adoc + spring.cloud.azure.active-directory.b2c.* + + + + + generate-appconf-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_appconf.adoc + spring.cloud.azure.appconfiguration.* + + + + + generate-cosmos-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_cosmos.adoc + spring.cloud.azure.cosmos.* + + + + + generate-eventhubs-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_eventhubs.adoc + spring.cloud.azure.eventhubs.* + + + + + generate-kv-secret-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_kv_secret.adoc + spring.cloud.azure.keyvault.secret.* + + + + + generate-kv-certificate-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_kv_certificate.adoc + spring.cloud.azure.keyvault.certificate.* + + + + + generate-servicebus-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_servicebus.adoc + spring.cloud.azure.servicebus.* + + + + + generate-servicebus-jms-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_servicebus_jms.adoc + spring.jms.servicebus.* + + + + + generate-storage-blob-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_storage_blob.adoc + spring.cloud.azure.storage.blob.* + + + + + generate-storage-fileshare-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_storage_fileshare.adoc + spring.cloud.azure.storage.fileshare.* + + + + + generate-storage-queue-configprops + prepare-package + + java + + + + ${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_storage_queue.adoc + spring.cloud.azure.storage.queue.* + + + + + + + org.asciidoctor + asciidoctor-maven-plugin + + + org.apache.maven.plugins + maven-antrun-plugin + + + maven-deploy-plugin + + + + + + + diff --git a/getting-started/src/main/.gitignore b/docs/src/main/.gitignore similarity index 100% rename from getting-started/src/main/.gitignore rename to docs/src/main/.gitignore diff --git a/getting-started/src/main/asciidoc/_attributes.adoc b/docs/src/main/asciidoc/_attributes.adoc similarity index 100% rename from getting-started/src/main/asciidoc/_attributes.adoc rename to docs/src/main/asciidoc/_attributes.adoc diff --git a/getting-started/src/main/asciidoc/docinfo.html b/docs/src/main/asciidoc/docinfo.html similarity index 100% rename from getting-started/src/main/asciidoc/docinfo.html rename to docs/src/main/asciidoc/docinfo.html diff --git a/docs/src/main/asciidoc/getting-started-guides.adoc b/docs/src/main/asciidoc/getting-started-guides.adoc new file mode 100644 index 00000000..4e30f154 --- /dev/null +++ b/docs/src/main/asciidoc/getting-started-guides.adoc @@ -0,0 +1,26 @@ + += Getting Started Guides + +== Spring Boot + +include::getting-started-guides/spring-boot/spring-boot-starters-for-azure.adoc[] +include::getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-storage.adoc[] +include::getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault.adoc[] +include::getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault-certificates.adoc[] +include::getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-service-bus.adoc[] + +== Spring Data + +TODO: finish this content. + +== Spring Security + +TODO: finish this content. + +== Spring Cloud + +TODO: finish this content. + +== Azure App Configuration + +TODO: finish this content. diff --git a/getting-started/src/main/asciidoc/spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault-certificates.adoc b/docs/src/main/asciidoc/getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault-certificates.adoc similarity index 100% rename from getting-started/src/main/asciidoc/spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault-certificates.adoc rename to docs/src/main/asciidoc/getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault-certificates.adoc diff --git a/getting-started/src/main/asciidoc/spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault.adoc b/docs/src/main/asciidoc/getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault.adoc similarity index 100% rename from getting-started/src/main/asciidoc/spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault.adoc rename to docs/src/main/asciidoc/getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault.adoc diff --git a/getting-started/src/main/asciidoc/spring-boot/configure-spring-boot-starter-java-app-with-azure-service-bus.adoc b/docs/src/main/asciidoc/getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-service-bus.adoc similarity index 100% rename from getting-started/src/main/asciidoc/spring-boot/configure-spring-boot-starter-java-app-with-azure-service-bus.adoc rename to docs/src/main/asciidoc/getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-service-bus.adoc diff --git a/getting-started/src/main/asciidoc/spring-boot/configure-spring-boot-starter-java-app-with-azure-storage.adoc b/docs/src/main/asciidoc/getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-storage.adoc similarity index 100% rename from getting-started/src/main/asciidoc/spring-boot/configure-spring-boot-starter-java-app-with-azure-storage.adoc rename to docs/src/main/asciidoc/getting-started-guides/spring-boot/configure-spring-boot-starter-java-app-with-azure-storage.adoc diff --git a/getting-started/src/main/asciidoc/spring-boot/spring-boot-starters-for-azure.adoc b/docs/src/main/asciidoc/getting-started-guides/spring-boot/spring-boot-starters-for-azure.adoc similarity index 100% rename from getting-started/src/main/asciidoc/spring-boot/spring-boot-starters-for-azure.adoc rename to docs/src/main/asciidoc/getting-started-guides/spring-boot/spring-boot-starters-for-azure.adoc diff --git a/scripts/update_gh-pages_branch.sh b/docs/src/main/asciidoc/ghpages.sh similarity index 72% rename from scripts/update_gh-pages_branch.sh rename to docs/src/main/asciidoc/ghpages.sh index 2fb2d630..602def30 100755 --- a/scripts/update_gh-pages_branch.sh +++ b/docs/src/main/asciidoc/ghpages.sh @@ -21,8 +21,6 @@ function set_default_props() { echo "Repo name is [${REPO_NAME}]" SPRING_CLOUD_STATIC_REPO=${SPRING_CLOUD_STATIC_REPO:-git@github.com:spring-cloud/spring-cloud-static.git} echo "Spring Cloud Static repo is [${SPRING_CLOUD_STATIC_REPO}" - MODULES=("getting-started" "portal" "reference" "samples" "tutorials") - echo "MODULES: ${MODULES[*]}" } # Check if gh-pages exists and docs have been built @@ -33,6 +31,11 @@ function check_if_anything_to_sync() { echo "No gh-pages, so not syncing" exit 0 fi + + if ! [ -d docs/target/generated-docs ] && ! [ "${BUILD}" == "yes" ]; then + echo "No gh-pages sources in docs/target/generated-docs, so not syncing" + exit 0 + fi } function retrieve_current_branch() { @@ -57,14 +60,35 @@ function switch_to_tag() { # Build the docs if switch is on function build_docs_if_applicable() { if [[ "${BUILD}" == "yes" ]] ; then - ./mvnw clean install -DskipTests + ./mvnw clean install -P docs -pl docs -DskipTests fi } +# Get the name of the `docs.main` property +# Get whitelisted 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" \ + -Dexec.args='${docs.main}' \ + --non-recursive \ + org.codehaus.mojo:exec-maven-plugin:1.3.1:exec) + echo "Extracted 'main.adoc' from Maven build [${MAIN_ADOC_VALUE}]" + + + WHITELIST_PROPERTY=${WHITELIST_PROPERTY:-"docs.whitelisted.branches"} + WHITELISTED_BRANCHES_VALUE=$("${MAVEN_PATH}"mvn -q \ + -Dexec.executable="echo" \ + -Dexec.args="\${${WHITELIST_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}]" +} + # Stash any outstanding changes function stash_changes() { - git diff-index --quiet HEAD && dirty=$? || (echo "Failed to check if the current repo is dirty. Assuming that it isn't." && dirty="") - if [ "$dirty" != "" ]; then git stash; fi + git diff-index --quiet HEAD && dirty=$? || (echo "Failed to check if the current repo is dirty. Assuming that it is." && dirty="1") + if [ "$dirty" != "0" ]; then git stash; fi } # Switch to gh-pages branch to sync it with current branch @@ -112,34 +136,41 @@ function add_docs_from_target() { function copy_docs_for_current_version() { if [[ "${CURRENT_BRANCH}" == "main" ]] ; then echo -e "Current branch is main - will copy the current docs only to the root folder" - for d in "${MODULES[@]}"; do - for f in "${d}"/target/generated-docs/*; do - file=${f#"${d}"/target/generated-docs/*} - if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then - # Not ignored... - cp -rf $f ${ROOT_FOLDER}/ - git add -A ${ROOT_FOLDER}/$file - fi - done + 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 + # Not ignored... + cp -rf $f ${ROOT_FOLDER}/ + git add -A ${ROOT_FOLDER}/$file + fi done COMMIT_CHANGES="yes" else echo -e "Current branch is [${CURRENT_BRANCH}]" - if [[ ",main," = ",${CURRENT_BRANCH}," ]] ; then + # 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 mkdir -p ${ROOT_FOLDER}/${CURRENT_BRANCH} - echo -e "Will copying the current docs to the [${CURRENT_BRANCH}] folder" - for d in "${MODULES[@]}"; do - for f in "${d}"/target/generated-docs/*; do - file=${f#"${d}"/target/generated-docs/*} - if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then + echo -e "Branch [${CURRENT_BRANCH}] is whitelisted! 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 + # Not ignored... + # We want users to access 1.0.0.RELEASE/ instead of 1.0.0.RELEASE/spring-cloud.sleuth.html + if [[ "${file}" == "${MAIN_ADOC_VALUE}.html" ]] ; then + # We don't want to copy the spring-cloud-sleuth.html + # we want it to be converted to index.html + cp -rf $f ${ROOT_FOLDER}/${CURRENT_BRANCH}/index.html + git add -A ${ROOT_FOLDER}/${CURRENT_BRANCH}/index.html + else cp -rf $f ${ROOT_FOLDER}/${CURRENT_BRANCH} git add -A ${ROOT_FOLDER}/${CURRENT_BRANCH}/$file fi - done + fi done COMMIT_CHANGES="yes" else - echo -e "Skipping for current branch: ${CURRENT_BRANCH}" + echo -e "Branch [${CURRENT_BRANCH}] is not on the white list! Check out the Maven [${WHITELIST_PROPERTY}] property in + [docs] module available under [docs] profile. Won't commit any changes to gh-pages for this branch." fi fi } @@ -149,12 +180,10 @@ function copy_docs_for_provided_version() { local FOLDER=${DESTINATION_REPO_FOLDER}/${VERSION} mkdir -p ${FOLDER} echo -e "Current tag is [v${VERSION}] Will copy the current docs to the [${FOLDER}] folder" - for d in "${MODULES[@]}"; do - for f in ${ROOT_FOLDER}/"${d}"/target/generated-docs/*; do - file=${f#${ROOT_FOLDER}/"${d}"/target/generated-docs/*} - copy_docs_for_branch ${file} ${FOLDER} - done - done; + for f in ${ROOT_FOLDER}/docs/target/generated-docs/*; do + file=${f#${ROOT_FOLDER}/docs/target/generated-docs/*} + copy_docs_for_branch ${file} ${FOLDER} + done COMMIT_CHANGES="yes" CURRENT_BRANCH="v${VERSION}" } @@ -167,8 +196,17 @@ function copy_docs_for_branch() { local file=$1 local destination=$2 if ! git ls-files -i -o --exclude-standard --directory | grep -q ^${file}$; then - cp -rf $f ${destination} - git add -A ${destination}/$file + # Not ignored... + # We want users to access 1.0.0.RELEASE/ instead of 1.0.0.RELEASE/spring-cloud.sleuth.html + if [[ ("${file}" == "${MAIN_ADOC_VALUE}.html") || ("${file}" == "${REPO_NAME}.html") ]] ; then + # We don't want to copy the spring-cloud-sleuth.html + # we want it to be converted to index.html + cp -rf $f ${destination}/index.html + git add -A ${destination}/index.html + else + cp -rf $f ${destination} + git add -A ${destination}/$file + fi fi } @@ -192,7 +230,7 @@ function checkout_previous_branch() { # If -version was provided we need to come back to root project cd ${ROOT_FOLDER} git checkout ${CURRENT_BRANCH} || echo "Failed to check the branch... continuing with the script" - if [ "$dirty" != "" ]; then git stash pop; fi + if [ "$dirty" != "0" ]; then git stash pop; fi exit 0 } @@ -286,6 +324,7 @@ else switch_to_tag fi build_docs_if_applicable +retrieve_doc_properties stash_changes add_docs_from_target checkout_previous_branch \ No newline at end of file diff --git a/docs/src/main/asciidoc/index.adoc b/docs/src/main/asciidoc/index.adoc new file mode 100644 index 00000000..e1742dda --- /dev/null +++ b/docs/src/main/asciidoc/index.adoc @@ -0,0 +1,8 @@ +include::_attributes.adoc[] + += Spring Cloud Azure + +include::getting-started-guides.adoc[] +include::tutorials.adoc[] +include::samples.adoc[] +include::reference.adoc[] diff --git a/docs/src/main/asciidoc/reference.adoc b/docs/src/main/asciidoc/reference.adoc new file mode 100644 index 00000000..72920c46 --- /dev/null +++ b/docs/src/main/asciidoc/reference.adoc @@ -0,0 +1,39 @@ + += Reference + +include::reference/version-information.adoc[] +include::reference/legal.adoc[] +include::reference/intro.adoc[] + +include::reference/getting-help.adoc[] +include::reference/whats-new-4.0.adoc[] +include::reference/migration-guide-for-4.0.adoc[] +include::reference/getting-started.adoc[] +include::reference/configuration.adoc[] +include::reference/authentication.adoc[] +include::reference/production-ready.adoc[] +include::reference/auto-configure-azure-sdk-clients.adoc[] +include::reference/resource-handling.adoc[] +include::reference/secret-management.adoc[] +include::reference/spring-data-support.adoc[] +include::reference/spring-security-support.adoc[] +include::reference/spring-integration-support.adoc[] +include::reference/spring-cloud-stream-support.adoc[] +include::reference/spring-jms-support.adoc[] +include::reference/kafka-support.adoc[] +include::reference/redis-support.adoc[] +include::reference/resource-manager.adoc[] +include::reference/configuration-properties.adoc[] + +== Appendix + +=== link:appendix.html##configuration-properties[Configuration properties] +=== link:appendix.html#migration-guide-for-4-0[Migration guide for 4.0] +=== link:appendix.html#known-issues[Known issues] + + +== link:https://projects.spring.io/spring-boot/[Spring Boot] + +== link:https://spring.io/projects[Spring Project References] + +== link:https://github.com/Microsoft/azure-spring-boot/[Spring Boot Starters for Azure] diff --git a/reference/src/main/asciidoc/_configprops.adoc b/docs/src/main/asciidoc/reference/_configprops.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops.adoc rename to docs/src/main/asciidoc/reference/_configprops.adoc diff --git a/reference/src/main/asciidoc/_configprops_aad.adoc b/docs/src/main/asciidoc/reference/_configprops_aad.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_aad.adoc rename to docs/src/main/asciidoc/reference/_configprops_aad.adoc diff --git a/reference/src/main/asciidoc/_configprops_aadb2c.adoc b/docs/src/main/asciidoc/reference/_configprops_aadb2c.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_aadb2c.adoc rename to docs/src/main/asciidoc/reference/_configprops_aadb2c.adoc diff --git a/reference/src/main/asciidoc/_configprops_appconf.adoc b/docs/src/main/asciidoc/reference/_configprops_appconf.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_appconf.adoc rename to docs/src/main/asciidoc/reference/_configprops_appconf.adoc diff --git a/reference/src/main/asciidoc/_configprops_cosmos.adoc b/docs/src/main/asciidoc/reference/_configprops_cosmos.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_cosmos.adoc rename to docs/src/main/asciidoc/reference/_configprops_cosmos.adoc diff --git a/reference/src/main/asciidoc/_configprops_eventhubs.adoc b/docs/src/main/asciidoc/reference/_configprops_eventhubs.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_eventhubs.adoc rename to docs/src/main/asciidoc/reference/_configprops_eventhubs.adoc diff --git a/reference/src/main/asciidoc/_configprops_global.adoc b/docs/src/main/asciidoc/reference/_configprops_global.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_global.adoc rename to docs/src/main/asciidoc/reference/_configprops_global.adoc diff --git a/reference/src/main/asciidoc/_configprops_kv_certificate.adoc b/docs/src/main/asciidoc/reference/_configprops_kv_certificate.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_kv_certificate.adoc rename to docs/src/main/asciidoc/reference/_configprops_kv_certificate.adoc diff --git a/reference/src/main/asciidoc/_configprops_kv_secret.adoc b/docs/src/main/asciidoc/reference/_configprops_kv_secret.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_kv_secret.adoc rename to docs/src/main/asciidoc/reference/_configprops_kv_secret.adoc diff --git a/reference/src/main/asciidoc/_configprops_servicebus.adoc b/docs/src/main/asciidoc/reference/_configprops_servicebus.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_servicebus.adoc rename to docs/src/main/asciidoc/reference/_configprops_servicebus.adoc diff --git a/reference/src/main/asciidoc/_configprops_servicebus_jms.adoc b/docs/src/main/asciidoc/reference/_configprops_servicebus_jms.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_servicebus_jms.adoc rename to docs/src/main/asciidoc/reference/_configprops_servicebus_jms.adoc diff --git a/reference/src/main/asciidoc/_configprops_storage_blob.adoc b/docs/src/main/asciidoc/reference/_configprops_storage_blob.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_storage_blob.adoc rename to docs/src/main/asciidoc/reference/_configprops_storage_blob.adoc diff --git a/reference/src/main/asciidoc/_configprops_storage_fileshare.adoc b/docs/src/main/asciidoc/reference/_configprops_storage_fileshare.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_storage_fileshare.adoc rename to docs/src/main/asciidoc/reference/_configprops_storage_fileshare.adoc diff --git a/reference/src/main/asciidoc/_configprops_storage_queue.adoc b/docs/src/main/asciidoc/reference/_configprops_storage_queue.adoc similarity index 100% rename from reference/src/main/asciidoc/_configprops_storage_queue.adoc rename to docs/src/main/asciidoc/reference/_configprops_storage_queue.adoc diff --git a/docs/src/main/asciidoc/reference/_configprops_storageblob.adoc b/docs/src/main/asciidoc/reference/_configprops_storageblob.adoc new file mode 100644 index 00000000..fc202139 --- /dev/null +++ b/docs/src/main/asciidoc/reference/_configprops_storageblob.adoc @@ -0,0 +1,75 @@ + +|=== +|Name | Default | Description + +|spring.cloud.azure.storage.blob.account-key | | Storage account access key. +|spring.cloud.azure.storage.blob.account-name | | Name for the storage account. +|spring.cloud.azure.storage.blob.blob-name | | Name of the blob. +|spring.cloud.azure.storage.blob.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. +|spring.cloud.azure.storage.blob.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved. +|spring.cloud.azure.storage.blob.client.connection-idle-timeout | | Amount of time before an idle connection. +|spring.cloud.azure.storage.blob.client.headers | | Comma-delimited list of headers applied to each request sent with client. +|spring.cloud.azure.storage.blob.client.logging.allowed-header-names | | Comma-delimited list of whitelisted headers that should be logged. +|spring.cloud.azure.storage.blob.client.logging.allowed-query-param-names | | Comma-delimited list of whitelisted query parameters. +|spring.cloud.azure.storage.blob.client.logging.level | | The level of detail to log on HTTP messages. +|spring.cloud.azure.storage.blob.client.logging.pretty-print-body | | Whether to pretty print the message bodies. +|spring.cloud.azure.storage.blob.client.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client. +|spring.cloud.azure.storage.blob.client.read-timeout | | Amount of time used when reading the server response. +|spring.cloud.azure.storage.blob.client.response-timeout | | Amount of time used when waiting for a server to reply. +|spring.cloud.azure.storage.blob.client.write-timeout | | Amount of time each request being sent over the wire. +|spring.cloud.azure.storage.blob.connection-string | | Connection string to connect to the service. +|spring.cloud.azure.storage.blob.container-name | | Name of the container. +|spring.cloud.azure.storage.blob.credential.client-certificate-password | | Password of the certificate file. +|spring.cloud.azure.storage.blob.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. +|spring.cloud.azure.storage.blob.credential.client-id | | Client id to use when performing service principal authentication with Azure. +|spring.cloud.azure.storage.blob.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. +|spring.cloud.azure.storage.blob.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id. +|spring.cloud.azure.storage.blob.credential.password | | Password to use when performing username/password authentication with Azure. +|spring.cloud.azure.storage.blob.credential.username | | Username to use when performing username/password authentication with Azure. +|spring.cloud.azure.storage.blob.customer-provided-key | | Customer provided key used to encrypt blob contents on the server. +|spring.cloud.azure.storage.blob.enabled | `true` | Whether an Azure Service is enabled. +|spring.cloud.azure.storage.blob.encryption-scope | | Encryption scope used to encrypt blob contents on the server. +|spring.cloud.azure.storage.blob.endpoint | | Endpoint for Azure Storage service. +|spring.cloud.azure.storage.blob.profile.cloud-type | | Name of the Azure cloud to connect to. +|spring.cloud.azure.storage.blob.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. +|spring.cloud.azure.storage.blob.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. +|spring.cloud.azure.storage.blob.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. +|spring.cloud.azure.storage.blob.profile.environment.active-directory-resource-id | | The Azure Active Directory resource id. +|spring.cloud.azure.storage.blob.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. +|spring.cloud.azure.storage.blob.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. +|spring.cloud.azure.storage.blob.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. +|spring.cloud.azure.storage.blob.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. +|spring.cloud.azure.storage.blob.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. +|spring.cloud.azure.storage.blob.profile.environment.gallery-endpoint | | The gallery endpoint. +|spring.cloud.azure.storage.blob.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. +|spring.cloud.azure.storage.blob.profile.environment.management-endpoint | | The management service endpoint. +|spring.cloud.azure.storage.blob.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. +|spring.cloud.azure.storage.blob.profile.environment.portal | | The management portal URL. +|spring.cloud.azure.storage.blob.profile.environment.publishing-profile | | The publishing settings file URL. +|spring.cloud.azure.storage.blob.profile.environment.resource-manager-endpoint | | The resource management endpoint. +|spring.cloud.azure.storage.blob.profile.environment.sql-management-endpoint | | The SQL management endpoint. +|spring.cloud.azure.storage.blob.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. +|spring.cloud.azure.storage.blob.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. +|spring.cloud.azure.storage.blob.profile.subscription-id | | Subscription id to use when connecting to Azure resources. +|spring.cloud.azure.storage.blob.profile.tenant-id | | Tenant id for Azure resources. +|spring.cloud.azure.storage.blob.proxy.hostname | | The host of the proxy. +|spring.cloud.azure.storage.blob.proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. +|spring.cloud.azure.storage.blob.proxy.password | | Password used to authenticate with the proxy. +|spring.cloud.azure.storage.blob.proxy.port | | The port of the proxy. +|spring.cloud.azure.storage.blob.proxy.type | | Type of the proxy. +|spring.cloud.azure.storage.blob.proxy.username | | Username used to authenticate with the proxy. +|spring.cloud.azure.storage.blob.resource.region | | The region of an Azure resource. +|spring.cloud.azure.storage.blob.resource.resource-group | | The resource group holds an Azure resource. +|spring.cloud.azure.storage.blob.resource.resource-id | | ID of an Azure resource. +|spring.cloud.azure.storage.blob.retry.exponential.base-delay | | Amount of time to wait between retry attempts. +|spring.cloud.azure.storage.blob.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. +|spring.cloud.azure.storage.blob.retry.exponential.max-retries | | The maximum number of attempts. +|spring.cloud.azure.storage.blob.retry.fixed.delay | | Amount of time to wait between retry attempts. +|spring.cloud.azure.storage.blob.retry.fixed.max-retries | | The maximum number of attempts. +|spring.cloud.azure.storage.blob.retry.mode | | Retry backoff mode. +|spring.cloud.azure.storage.blob.retry.secondary-host | | Secondary Storage account to retry requests against. +|spring.cloud.azure.storage.blob.retry.try-timeout | | Amount of time to wait until a timeout. +|spring.cloud.azure.storage.blob.sas-token | | Shared access signatures (SAS) token used to authorize requests sent to the service. +|spring.cloud.azure.storage.blob.service-version | | Blob service version used when making API requests. + +|=== \ No newline at end of file diff --git a/docs/src/main/asciidoc/reference/_configprops_storagefileshare.adoc b/docs/src/main/asciidoc/reference/_configprops_storagefileshare.adoc new file mode 100644 index 00000000..0003e25c --- /dev/null +++ b/docs/src/main/asciidoc/reference/_configprops_storagefileshare.adoc @@ -0,0 +1,74 @@ + +|=== +|Name | Default | Description + +|spring.cloud.azure.storage.fileshare.account-key | | Storage account access key. +|spring.cloud.azure.storage.fileshare.account-name | | Name for the storage account. +|spring.cloud.azure.storage.fileshare.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. +|spring.cloud.azure.storage.fileshare.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved. +|spring.cloud.azure.storage.fileshare.client.connection-idle-timeout | | Amount of time before an idle connection. +|spring.cloud.azure.storage.fileshare.client.headers | | Comma-delimited list of headers applied to each request sent with client. +|spring.cloud.azure.storage.fileshare.client.logging.allowed-header-names | | Comma-delimited list of whitelisted headers that should be logged. +|spring.cloud.azure.storage.fileshare.client.logging.allowed-query-param-names | | Comma-delimited list of whitelisted query parameters. +|spring.cloud.azure.storage.fileshare.client.logging.level | | The level of detail to log on HTTP messages. +|spring.cloud.azure.storage.fileshare.client.logging.pretty-print-body | | Whether to pretty print the message bodies. +|spring.cloud.azure.storage.fileshare.client.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client. +|spring.cloud.azure.storage.fileshare.client.read-timeout | | Amount of time used when reading the server response. +|spring.cloud.azure.storage.fileshare.client.response-timeout | | Amount of time used when waiting for a server to reply. +|spring.cloud.azure.storage.fileshare.client.write-timeout | | Amount of time each request being sent over the wire. +|spring.cloud.azure.storage.fileshare.connection-string | | Connection string to connect to the service. +|spring.cloud.azure.storage.fileshare.credential.client-certificate-password | | Password of the certificate file. +|spring.cloud.azure.storage.fileshare.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. +|spring.cloud.azure.storage.fileshare.credential.client-id | | Client id to use when performing service principal authentication with Azure. +|spring.cloud.azure.storage.fileshare.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. +|spring.cloud.azure.storage.fileshare.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id. +|spring.cloud.azure.storage.fileshare.credential.password | | Password to use when performing username/password authentication with Azure. +|spring.cloud.azure.storage.fileshare.credential.username | | Username to use when performing username/password authentication with Azure. +|spring.cloud.azure.storage.fileshare.directory-path | | Path to the directory. For instance, 'directory1/directory2'. +|spring.cloud.azure.storage.fileshare.enabled | `true` | Whether an Azure Service is enabled. +|spring.cloud.azure.storage.fileshare.endpoint | | Endpoint for Azure Storage service. +|spring.cloud.azure.storage.fileshare.file-path | | Path to the file. For instance, 'directory1/file1'. +|spring.cloud.azure.storage.fileshare.profile.cloud-type | | Name of the Azure cloud to connect to. +|spring.cloud.azure.storage.fileshare.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. +|spring.cloud.azure.storage.fileshare.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. +|spring.cloud.azure.storage.fileshare.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. +|spring.cloud.azure.storage.fileshare.profile.environment.active-directory-resource-id | | The Azure Active Directory resource id. +|spring.cloud.azure.storage.fileshare.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. +|spring.cloud.azure.storage.fileshare.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. +|spring.cloud.azure.storage.fileshare.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. +|spring.cloud.azure.storage.fileshare.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. +|spring.cloud.azure.storage.fileshare.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. +|spring.cloud.azure.storage.fileshare.profile.environment.gallery-endpoint | | The gallery endpoint. +|spring.cloud.azure.storage.fileshare.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. +|spring.cloud.azure.storage.fileshare.profile.environment.management-endpoint | | The management service endpoint. +|spring.cloud.azure.storage.fileshare.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. +|spring.cloud.azure.storage.fileshare.profile.environment.portal | | The management portal URL. +|spring.cloud.azure.storage.fileshare.profile.environment.publishing-profile | | The publishing settings file URL. +|spring.cloud.azure.storage.fileshare.profile.environment.resource-manager-endpoint | | The resource management endpoint. +|spring.cloud.azure.storage.fileshare.profile.environment.sql-management-endpoint | | The SQL management endpoint. +|spring.cloud.azure.storage.fileshare.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. +|spring.cloud.azure.storage.fileshare.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. +|spring.cloud.azure.storage.fileshare.profile.subscription-id | | Subscription id to use when connecting to Azure resources. +|spring.cloud.azure.storage.fileshare.profile.tenant-id | | Tenant id for Azure resources. +|spring.cloud.azure.storage.fileshare.proxy.hostname | | The host of the proxy. +|spring.cloud.azure.storage.fileshare.proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. +|spring.cloud.azure.storage.fileshare.proxy.password | | Password used to authenticate with the proxy. +|spring.cloud.azure.storage.fileshare.proxy.port | | The port of the proxy. +|spring.cloud.azure.storage.fileshare.proxy.type | | Type of the proxy. +|spring.cloud.azure.storage.fileshare.proxy.username | | Username used to authenticate with the proxy. +|spring.cloud.azure.storage.fileshare.resource.region | | The region of an Azure resource. +|spring.cloud.azure.storage.fileshare.resource.resource-group | | The resource group holds an Azure resource. +|spring.cloud.azure.storage.fileshare.resource.resource-id | | ID of an Azure resource. +|spring.cloud.azure.storage.fileshare.retry.exponential.base-delay | | Amount of time to wait between retry attempts. +|spring.cloud.azure.storage.fileshare.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. +|spring.cloud.azure.storage.fileshare.retry.exponential.max-retries | | The maximum number of attempts. +|spring.cloud.azure.storage.fileshare.retry.fixed.delay | | Amount of time to wait between retry attempts. +|spring.cloud.azure.storage.fileshare.retry.fixed.max-retries | | The maximum number of attempts. +|spring.cloud.azure.storage.fileshare.retry.mode | | Retry backoff mode. +|spring.cloud.azure.storage.fileshare.retry.secondary-host | | Secondary Storage account to retry requests against. +|spring.cloud.azure.storage.fileshare.retry.try-timeout | | Amount of time to wait until a timeout. +|spring.cloud.azure.storage.fileshare.sas-token | | Shared access signatures (SAS) token used to authorize requests sent to the service. +|spring.cloud.azure.storage.fileshare.service-version | | Share service version used when making API requests +|spring.cloud.azure.storage.fileshare.share-name | | Name of the share. + +|=== \ No newline at end of file diff --git a/docs/src/main/asciidoc/reference/_configprops_storagequeue.adoc b/docs/src/main/asciidoc/reference/_configprops_storagequeue.adoc new file mode 100644 index 00000000..7667f2e0 --- /dev/null +++ b/docs/src/main/asciidoc/reference/_configprops_storagequeue.adoc @@ -0,0 +1,74 @@ + +|=== +|Name | Default | Description + +|spring.cloud.azure.storage.queue.account-key | | Storage account access key. +|spring.cloud.azure.storage.queue.account-name | | Name for the storage account. +|spring.cloud.azure.storage.queue.client.application-id | | Represents current application and is used for telemetry/monitoring purposes. +|spring.cloud.azure.storage.queue.client.connect-timeout | | Amount of time the request attempts to connect to the remote host and the connection is resolved. +|spring.cloud.azure.storage.queue.client.connection-idle-timeout | | Amount of time before an idle connection. +|spring.cloud.azure.storage.queue.client.headers | | Comma-delimited list of headers applied to each request sent with client. +|spring.cloud.azure.storage.queue.client.logging.allowed-header-names | | Comma-delimited list of whitelisted headers that should be logged. +|spring.cloud.azure.storage.queue.client.logging.allowed-query-param-names | | Comma-delimited list of whitelisted query parameters. +|spring.cloud.azure.storage.queue.client.logging.level | | The level of detail to log on HTTP messages. +|spring.cloud.azure.storage.queue.client.logging.pretty-print-body | | Whether to pretty print the message bodies. +|spring.cloud.azure.storage.queue.client.maximum-connection-pool-size | | Maximum connection pool size used by the underlying HTTP client. +|spring.cloud.azure.storage.queue.client.read-timeout | | Amount of time used when reading the server response. +|spring.cloud.azure.storage.queue.client.response-timeout | | Amount of time used when waiting for a server to reply. +|spring.cloud.azure.storage.queue.client.write-timeout | | Amount of time each request being sent over the wire. +|spring.cloud.azure.storage.queue.connection-string | | Connection string to connect to the service. +|spring.cloud.azure.storage.queue.credential.client-certificate-password | | Password of the certificate file. +|spring.cloud.azure.storage.queue.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure. +|spring.cloud.azure.storage.queue.credential.client-id | | Client id to use when performing service principal authentication with Azure. +|spring.cloud.azure.storage.queue.credential.client-secret | | Client secret to use when performing service principal authentication with Azure. +|spring.cloud.azure.storage.queue.credential.managed-identity-enabled | `false` | Whether to enable managed identity to authenticate with Azure. If true and the client-id is set, will use the client id as user assigned managed identity client id. +|spring.cloud.azure.storage.queue.credential.password | | Password to use when performing username/password authentication with Azure. +|spring.cloud.azure.storage.queue.credential.username | | Username to use when performing username/password authentication with Azure. +|spring.cloud.azure.storage.queue.enabled | `true` | Whether an Azure Service is enabled. +|spring.cloud.azure.storage.queue.endpoint | | Endpoint for Azure Storage service. +|spring.cloud.azure.storage.queue.message-encoding | | How queue message body is represented in HTTP requests and responses. +|spring.cloud.azure.storage.queue.profile.cloud-type | | Name of the Azure cloud to connect to. +|spring.cloud.azure.storage.queue.profile.environment.active-directory-endpoint | | The Azure Active Directory endpoint to connect to. +|spring.cloud.azure.storage.queue.profile.environment.active-directory-graph-api-version | | The Azure Active Directory Graph API version. +|spring.cloud.azure.storage.queue.profile.environment.active-directory-graph-endpoint | | The Azure Active Directory Graph endpoint. +|spring.cloud.azure.storage.queue.profile.environment.active-directory-resource-id | | The Azure Active Directory resource id. +|spring.cloud.azure.storage.queue.profile.environment.azure-application-insights-endpoint | | The Azure Application Insights endpoint. +|spring.cloud.azure.storage.queue.profile.environment.azure-data-lake-analytics-catalog-and-job-endpoint-suffix | | The Data Lake analytics catalog and job endpoint suffix. +|spring.cloud.azure.storage.queue.profile.environment.azure-data-lake-store-file-system-endpoint-suffix | | The Data Lake storage file system endpoint suffix. +|spring.cloud.azure.storage.queue.profile.environment.azure-log-analytics-endpoint | | The Azure Log Analytics endpoint. +|spring.cloud.azure.storage.queue.profile.environment.data-lake-endpoint-resource-id | | The Data Lake endpoint. +|spring.cloud.azure.storage.queue.profile.environment.gallery-endpoint | | The gallery endpoint. +|spring.cloud.azure.storage.queue.profile.environment.key-vault-dns-suffix | | The Key Vault DNS suffix. +|spring.cloud.azure.storage.queue.profile.environment.management-endpoint | | The management service endpoint. +|spring.cloud.azure.storage.queue.profile.environment.microsoft-graph-endpoint | | The Microsoft Graph endpoint. +|spring.cloud.azure.storage.queue.profile.environment.portal | | The management portal URL. +|spring.cloud.azure.storage.queue.profile.environment.publishing-profile | | The publishing settings file URL. +|spring.cloud.azure.storage.queue.profile.environment.resource-manager-endpoint | | The resource management endpoint. +|spring.cloud.azure.storage.queue.profile.environment.sql-management-endpoint | | The SQL management endpoint. +|spring.cloud.azure.storage.queue.profile.environment.sql-server-hostname-suffix | | The SQL Server hostname suffix. +|spring.cloud.azure.storage.queue.profile.environment.storage-endpoint-suffix | | The Storage endpoint suffix. +|spring.cloud.azure.storage.queue.profile.subscription-id | | Subscription id to use when connecting to Azure resources. +|spring.cloud.azure.storage.queue.profile.tenant-id | | Tenant id for Azure resources. +|spring.cloud.azure.storage.queue.proxy.hostname | | The host of the proxy. +|spring.cloud.azure.storage.queue.proxy.non-proxy-hosts | | A list of hosts or CIDR to not use proxy HTTP/HTTPS connections through. +|spring.cloud.azure.storage.queue.proxy.password | | Password used to authenticate with the proxy. +|spring.cloud.azure.storage.queue.proxy.port | | The port of the proxy. +|spring.cloud.azure.storage.queue.proxy.type | | Type of the proxy. +|spring.cloud.azure.storage.queue.proxy.username | | Username used to authenticate with the proxy. +|spring.cloud.azure.storage.queue.queue-name | | Name of the storage queue. +|spring.cloud.azure.storage.queue.resource.name | | Name of the storage account. +|spring.cloud.azure.storage.queue.resource.region | | The region of an Azure resource. +|spring.cloud.azure.storage.queue.resource.resource-group | | The resource group holds an Azure resource. +|spring.cloud.azure.storage.queue.resource.resource-id | | ID of an Azure resource. +|spring.cloud.azure.storage.queue.retry.exponential.base-delay | | Amount of time to wait between retry attempts. +|spring.cloud.azure.storage.queue.retry.exponential.max-delay | | Maximum permissible amount of time between retry attempts. +|spring.cloud.azure.storage.queue.retry.exponential.max-retries | | The maximum number of attempts. +|spring.cloud.azure.storage.queue.retry.fixed.delay | | Amount of time to wait between retry attempts. +|spring.cloud.azure.storage.queue.retry.fixed.max-retries | | The maximum number of attempts. +|spring.cloud.azure.storage.queue.retry.mode | | Retry backoff mode. +|spring.cloud.azure.storage.queue.retry.secondary-host | | Secondary Storage account to retry requests against. +|spring.cloud.azure.storage.queue.retry.try-timeout | | Amount of time to wait until a timeout. +|spring.cloud.azure.storage.queue.sas-token | | Shared access signatures (SAS) token used to authorize requests sent to the service. +|spring.cloud.azure.storage.queue.service-version | | Queue service version used when making API requests. + +|=== \ No newline at end of file diff --git a/reference/src/main/asciidoc/_known-issues.adoc b/docs/src/main/asciidoc/reference/_known-issues.adoc similarity index 100% rename from reference/src/main/asciidoc/_known-issues.adoc rename to docs/src/main/asciidoc/reference/_known-issues.adoc diff --git a/reference/src/main/asciidoc/_migration-guide-for-4.0.adoc b/docs/src/main/asciidoc/reference/_migration-guide-for-4.0.adoc similarity index 100% rename from reference/src/main/asciidoc/_migration-guide-for-4.0.adoc rename to docs/src/main/asciidoc/reference/_migration-guide-for-4.0.adoc diff --git a/docs/src/main/asciidoc/reference/appendix.adoc b/docs/src/main/asciidoc/reference/appendix.adoc new file mode 100644 index 00000000..d5fdde69 --- /dev/null +++ b/docs/src/main/asciidoc/reference/appendix.adoc @@ -0,0 +1,66 @@ + +[appendix] +== Configuration Properties + +=== Global Properties + +include::reference/_configprops_global.adoc[] + +=== Azure Active Directory Properties + +include::reference/_configprops_aad.adoc[] + +=== Azure Active Directory B2C Properties + +include::reference/_configprops_aadb2c.adoc[] + +=== Azure App Configuration Properties + +include::reference/_configprops_appconf.adoc[] + +=== Azure Cosmos Properties + +include::reference/_configprops_cosmos.adoc[] + +=== Azure Event Hubs Properties + +include::reference/_configprops_eventhubs.adoc[] + +=== Azure Key Vault Secrets Properties + +include::reference/_configprops_kv_secret.adoc[] + +=== Azure Key Vault Certificates Properties + +include::reference/_configprops_kv_certificate.adoc[] + +=== Azure Service Bus Properties + +include::reference/_configprops_servicebus.adoc[] + +=== Azure Service Bus JMS Properties + +include::reference/_configprops_servicebus_jms.adoc[] + +=== Azure Storage Blob Properties + +include::reference/_configprops_storage_blob.adoc[] + +=== Azure Storage File Share Properties + +include::reference/_configprops_storage_fileshare.adoc[] + +=== Azure Storage Queue Properties + +include::reference/_configprops_storage_queue.adoc[] + +=== All Configuration Properties + +include::reference/_configprops.adoc[] + +[appendix] +include::reference/_migration-guide-for-4.0.adoc[] + +[appendix] +include::reference/_known-issues.adoc[] + diff --git a/reference/src/main/asciidoc/authentication.adoc b/docs/src/main/asciidoc/reference/authentication.adoc similarity index 100% rename from reference/src/main/asciidoc/authentication.adoc rename to docs/src/main/asciidoc/reference/authentication.adoc diff --git a/reference/src/main/asciidoc/auto-configure-azure-sdk-clients.adoc b/docs/src/main/asciidoc/reference/auto-configure-azure-sdk-clients.adoc similarity index 100% rename from reference/src/main/asciidoc/auto-configure-azure-sdk-clients.adoc rename to docs/src/main/asciidoc/reference/auto-configure-azure-sdk-clients.adoc diff --git a/reference/src/main/asciidoc/configuration-properties.adoc b/docs/src/main/asciidoc/reference/configuration-properties.adoc similarity index 100% rename from reference/src/main/asciidoc/configuration-properties.adoc rename to docs/src/main/asciidoc/reference/configuration-properties.adoc diff --git a/reference/src/main/asciidoc/configuration.adoc b/docs/src/main/asciidoc/reference/configuration.adoc similarity index 100% rename from reference/src/main/asciidoc/configuration.adoc rename to docs/src/main/asciidoc/reference/configuration.adoc diff --git a/reference/src/main/asciidoc/getting-help.adoc b/docs/src/main/asciidoc/reference/getting-help.adoc similarity index 100% rename from reference/src/main/asciidoc/getting-help.adoc rename to docs/src/main/asciidoc/reference/getting-help.adoc diff --git a/reference/src/main/asciidoc/getting-started.adoc b/docs/src/main/asciidoc/reference/getting-started.adoc similarity index 100% rename from reference/src/main/asciidoc/getting-started.adoc rename to docs/src/main/asciidoc/reference/getting-started.adoc diff --git a/reference/src/main/asciidoc/intro.adoc b/docs/src/main/asciidoc/reference/intro.adoc similarity index 100% rename from reference/src/main/asciidoc/intro.adoc rename to docs/src/main/asciidoc/reference/intro.adoc diff --git a/reference/src/main/asciidoc/kafka-support.adoc b/docs/src/main/asciidoc/reference/kafka-support.adoc similarity index 100% rename from reference/src/main/asciidoc/kafka-support.adoc rename to docs/src/main/asciidoc/reference/kafka-support.adoc diff --git a/reference/src/main/asciidoc/legal.adoc b/docs/src/main/asciidoc/reference/legal.adoc similarity index 100% rename from reference/src/main/asciidoc/legal.adoc rename to docs/src/main/asciidoc/reference/legal.adoc diff --git a/reference/src/main/asciidoc/migration-guide-for-4.0.adoc b/docs/src/main/asciidoc/reference/migration-guide-for-4.0.adoc similarity index 100% rename from reference/src/main/asciidoc/migration-guide-for-4.0.adoc rename to docs/src/main/asciidoc/reference/migration-guide-for-4.0.adoc diff --git a/reference/src/main/asciidoc/production-ready.adoc b/docs/src/main/asciidoc/reference/production-ready.adoc similarity index 100% rename from reference/src/main/asciidoc/production-ready.adoc rename to docs/src/main/asciidoc/reference/production-ready.adoc diff --git a/reference/src/main/asciidoc/redis-support.adoc b/docs/src/main/asciidoc/reference/redis-support.adoc similarity index 100% rename from reference/src/main/asciidoc/redis-support.adoc rename to docs/src/main/asciidoc/reference/redis-support.adoc diff --git a/reference/src/main/asciidoc/resource-handling.adoc b/docs/src/main/asciidoc/reference/resource-handling.adoc similarity index 100% rename from reference/src/main/asciidoc/resource-handling.adoc rename to docs/src/main/asciidoc/reference/resource-handling.adoc diff --git a/reference/src/main/asciidoc/resource-manager.adoc b/docs/src/main/asciidoc/reference/resource-manager.adoc similarity index 100% rename from reference/src/main/asciidoc/resource-manager.adoc rename to docs/src/main/asciidoc/reference/resource-manager.adoc diff --git a/reference/src/main/asciidoc/secret-management.adoc b/docs/src/main/asciidoc/reference/secret-management.adoc similarity index 100% rename from reference/src/main/asciidoc/secret-management.adoc rename to docs/src/main/asciidoc/reference/secret-management.adoc diff --git a/reference/src/main/asciidoc/spring-cloud-stream-support.adoc b/docs/src/main/asciidoc/reference/spring-cloud-stream-support.adoc similarity index 100% rename from reference/src/main/asciidoc/spring-cloud-stream-support.adoc rename to docs/src/main/asciidoc/reference/spring-cloud-stream-support.adoc diff --git a/reference/src/main/asciidoc/spring-data-support.adoc b/docs/src/main/asciidoc/reference/spring-data-support.adoc similarity index 100% rename from reference/src/main/asciidoc/spring-data-support.adoc rename to docs/src/main/asciidoc/reference/spring-data-support.adoc diff --git a/reference/src/main/asciidoc/spring-integration-support.adoc b/docs/src/main/asciidoc/reference/spring-integration-support.adoc similarity index 100% rename from reference/src/main/asciidoc/spring-integration-support.adoc rename to docs/src/main/asciidoc/reference/spring-integration-support.adoc diff --git a/reference/src/main/asciidoc/spring-jms-support.adoc b/docs/src/main/asciidoc/reference/spring-jms-support.adoc similarity index 100% rename from reference/src/main/asciidoc/spring-jms-support.adoc rename to docs/src/main/asciidoc/reference/spring-jms-support.adoc diff --git a/reference/src/main/asciidoc/spring-security-support.adoc b/docs/src/main/asciidoc/reference/spring-security-support.adoc similarity index 100% rename from reference/src/main/asciidoc/spring-security-support.adoc rename to docs/src/main/asciidoc/reference/spring-security-support.adoc diff --git a/reference/src/main/asciidoc/version-information.adoc b/docs/src/main/asciidoc/reference/version-information.adoc similarity index 100% rename from reference/src/main/asciidoc/version-information.adoc rename to docs/src/main/asciidoc/reference/version-information.adoc diff --git a/reference/src/main/asciidoc/whats-new-4.0.adoc b/docs/src/main/asciidoc/reference/whats-new-4.0.adoc similarity index 100% rename from reference/src/main/asciidoc/whats-new-4.0.adoc rename to docs/src/main/asciidoc/reference/whats-new-4.0.adoc diff --git a/samples/src/main/asciidoc/index.adoc b/docs/src/main/asciidoc/samples.adoc similarity index 89% rename from samples/src/main/asciidoc/index.adoc rename to docs/src/main/asciidoc/samples.adoc index 183d5ec3..acc8a8ea 100644 --- a/samples/src/main/asciidoc/index.adoc +++ b/docs/src/main/asciidoc/samples.adoc @@ -1,6 +1,4 @@ -include::_attributes.adoc[] - = Sample == link:https://github.com/Microsoft/todo-app-java-on-azure/[To Do List with Cosmos DB] diff --git a/tutorials/src/main/asciidoc/index.adoc b/docs/src/main/asciidoc/tutorials.adoc similarity index 92% rename from tutorials/src/main/asciidoc/index.adoc rename to docs/src/main/asciidoc/tutorials.adoc index 9ab6322e..fdafe3a6 100644 --- a/tutorials/src/main/asciidoc/index.adoc +++ b/docs/src/main/asciidoc/tutorials.adoc @@ -1,6 +1,4 @@ -include::_attributes.adoc[] - = Tutorials == link:https://spring.io/guides/gs/spring-boot-for-azure/[Deploy to App Service and Azure Spring Cloud] diff --git a/getting-started/pom.xml b/getting-started/pom.xml deleted file mode 100644 index 357c53ee..00000000 --- a/getting-started/pom.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - 4.0.0 - - - com.azure.spring - spring-cloud-azure-docs - 4.1.0-beta.1 - ../pom.xml - - - spring-cloud-azure-docs-getting-started - 4.1.0-beta.1 - - - ${project.build.directory}/generated-docs/${project.version}/getting-started/html - - - diff --git a/getting-started/src/main/asciidoc/index.adoc b/getting-started/src/main/asciidoc/index.adoc deleted file mode 100644 index fe83bfc5..00000000 --- a/getting-started/src/main/asciidoc/index.adoc +++ /dev/null @@ -1,28 +0,0 @@ - -include::_attributes.adoc[] - -= Getting Started - -== Spring Boot - -include::spring-boot/spring-boot-starters-for-azure.adoc[] -include::spring-boot/configure-spring-boot-starter-java-app-with-azure-storage.adoc[] -include::spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault.adoc[] -include::spring-boot/configure-spring-boot-starter-java-app-with-azure-key-vault-certificates.adoc[] -include::spring-boot/configure-spring-boot-starter-java-app-with-azure-service-bus.adoc[] - -== Spring Data - -TODO: finish this content. - -== Spring Security - -TODO: finish this content. - -== Spring Cloud - -TODO: finish this content. - -== Azure App Configuration - -TODO: finish this content. diff --git a/pom.xml b/pom.xml index 1fbe83ce..5ed71d50 100644 --- a/pom.xml +++ b/pom.xml @@ -1,117 +1,228 @@ - - 4.0.0 + - com.azure.spring - spring-cloud-azure-docs - 4.1.0-beta.1 - pom + + 4.0.0 + + org.springframework.cloud + spring-cloud-build + 3.1.1 + + - - portal - reference - getting-started - samples - tutorials - + com.azure.spring + spring-cloud-azure-aggregator + 4.1.0-beta.1 + pom + Spring Cloud Azure + Spring Cloud Azure - - 0.2.5 - ${project.build.directory}/docs/ - ${project.build.directory}/generated-docs/html - - - - spring-releases - Spring Releases - https://repo.spring.io/release - - - - + + + + 2.8.2 + + 3.1.1 + + 4.1.0-beta.1 + 0.0.29 + 1.8 + 1.8 + + + + docs + + + + + + com.azure.spring + spring-cloud-azure-dependencies + ${version.spring.cloud.azure} + pom + import + + + org.springframework.cloud + spring-cloud-commons-dependencies + ${spring-cloud-commons.version} + pom + import + + + + + + + + org.slf4j + slf4j-api + + + org.springframework.boot + spring-boot-starter-test + test + + + org.junit.vintage + junit-vintage-engine + + + junit + junit + + + + + + + + + + maven-compiler-plugin + + + + -Xlint:all + + -Xlint:-options + + -Xlint:-serial + + + + + + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + io.spring.javaformat + spring-javaformat-maven-plugin + + + validate + true + + validate + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.3.2 + + + https://docs.oracle.com/javase/8/docs/api/ + https://docs.oracle.com/javaee/8/api/ + https://fasterxml.github.io/jackson-core/javadoc/2.8/ + https://docs.spring.io/spring/docs/5.3.x/javadoc-api/ + + true +
${project.name}
+ ${project.build.directory}/site/${project.version}/apidocs + + + + + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + + + + + spring + + + spring-snapshots + Spring Snapshots + https://repo.spring.io/libs-snapshot-local + + true + + + false + + + + spring-milestones + Spring Milestones + https://repo.spring.io/libs-milestone-local + + false + + + + spring-releases + Spring Releases + https://repo.spring.io/release + + false + + + + + + spring-snapshots + Spring Snapshots + https://repo.spring.io/libs-snapshot-local + + true + + + false + + + + spring-milestones + Spring Milestones + https://repo.spring.io/libs-milestone-local + + false + + + + spring-releases + Spring Releases + https://repo.spring.io/libs-release-local + + false + + + + + + + - - - - com.googlecode.maven-download-plugin - download-maven-plugin - 1.6.8 - - - unpack-doc-resources - generate-resources - - wget - - - - https://repo.spring.io/release/io/spring/docresources/spring-doc-resources/${spring-doc-resources.version}/spring-doc-resources-${spring-doc-resources.version}.zip - - true - ${docs.build.directory} - - - - - - org.apache.maven.plugins - maven-resources-plugin - - - copy-asciidoc-resources - generate-resources - - copy-resources - - - ${docs.build.directory} - - - src/main/asciidoc - - - - - - - - org.asciidoctor - asciidoctor-maven-plugin - - ${docs.build.directory} - - - - generate-html-documentation - prepare-package - - process-asciidoc - - - html5 - book - ${docs.output.directory} - - // these attributes are required to use the doc resources - shared - css/ - spring.css - true - font - js/highlight - github - highlight.js - ${project.version} - - - - - - - diff --git a/portal/.vale-styles/Microsoft/AMPM.yml b/portal/.vale-styles/Microsoft/AMPM.yml deleted file mode 100644 index 8b9fed16..00000000 --- a/portal/.vale-styles/Microsoft/AMPM.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: Use 'AM' or 'PM' (preceded by a space). -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms -level: error -nonword: true -tokens: - - '\d{1,2}[AP]M' - - '\d{1,2} ?[ap]m' - - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/portal/.vale-styles/Microsoft/Accessibility.yml b/portal/.vale-styles/Microsoft/Accessibility.yml deleted file mode 100644 index 05bf9273..00000000 --- a/portal/.vale-styles/Microsoft/Accessibility.yml +++ /dev/null @@ -1,25 +0,0 @@ -extends: existence -message: "Don't use language (such as '%s') that defines people by their disability." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms -level: suggestion -ignorecase: true -tokens: - - a victim of - - able-bodied - - affected by - - an epileptic - - crippled - - disabled - - dumb - - handicapped - - handicaps - - healthy - - lame - - maimed - - missing a limb - - mute - - normal - - sight-impaired - - stricken with - - suffers from - - vision-impaired diff --git a/portal/.vale-styles/Microsoft/Acronyms.yml b/portal/.vale-styles/Microsoft/Acronyms.yml deleted file mode 100644 index 82f240ab..00000000 --- a/portal/.vale-styles/Microsoft/Acronyms.yml +++ /dev/null @@ -1,73 +0,0 @@ -extends: conditional -message: "'%s' has no definition." -link: https://docs.microsoft.com/en-us/style-guide/acronyms -level: suggestion -ignorecase: false -# Ensures that the existence of 'first' implies the existence of 'second'. -first: '\b([A-Z]{3,5})\b' -second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' -# ... with the exception of these: -exceptions: - - API - - ASP - - CLI - - CPU - - CSS - - CSV - - DEBUG - - DOM - - DPI - - FAQ - - GCC - - GDB - - GET - - GPU - - GTK - - GUI - - HTML - - HTTP - - HTTPS - - IDE - - JAR - - JSON - - JSX - - LESS - - LLDB - - NET - - NOTE - - NVDA - - OSS - - PATH - - PDF - - PHP - - POST - - RAM - - REPL - - RSA - - SCM - - SCSS - - SDK - - SQL - - SSH - - SSL - - SVG - - TBD - - TCP - - TODO - - URI - - URL - - USB - - UTF - - XML - - XSS - - YAML - - ZIP - - BOM - - AMQP - - AAD - - POSIX - - AKS - - PEM - - CRUD - - SAS - - JMS diff --git a/portal/.vale-styles/Microsoft/Adverbs.yml b/portal/.vale-styles/Microsoft/Adverbs.yml deleted file mode 100644 index 07d98d83..00000000 --- a/portal/.vale-styles/Microsoft/Adverbs.yml +++ /dev/null @@ -1,270 +0,0 @@ -extends: existence -message: "Consider removing '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: warning -action: - name: remove -tokens: - - abnormally - - absentmindedly - - accidentally - - adventurously - - anxiously - - arrogantly - - awkwardly - - bashfully - - beautifully - - bitterly - - bleakly - - blindly - - blissfully - - boastfully - - boldly - - bravely - - briefly - - brightly - - briskly - - broadly - - busily - - calmly - - carefully - - carelessly - - cautiously - - cheerfully - - cleverly - - closely - - coaxingly - - colorfully - - continually - - coolly - - courageously - - crossly - - cruelly - - curiously - - daintily - - dearly - - deceivingly - - deeply - - defiantly - - deliberately - - delightfully - - diligently - - dimly - - doubtfully - - dreamily - - easily - - elegantly - - energetically - - enormously - - enthusiastically - - excitedly - - extremely - - fairly - - faithfully - - famously - - ferociously - - fervently - - fiercely - - fondly - - foolishly - - fortunately - - frankly - - frantically - - freely - - frenetically - - frightfully - - furiously - - generally - - generously - - gently - - gladly - - gleefully - - gracefully - - gratefully - - greatly - - greedily - - happily - - hastily - - healthily - - heavily - - helplessly - - honestly - - hopelessly - - hungrily - - innocently - - inquisitively - - intensely - - intently - - interestingly - - inwardly - - irritably - - jaggedly - - jealously - - jovially - - joyfully - - joyously - - jubilantly - - judgmentally - - justly - - keenly - - kiddingly - - kindheartedly - - knavishly - - knowingly - - knowledgeably - - lazily - - lightly - - limply - - lively - - loftily - - longingly - - loosely - - loudly - - lovingly - - loyally - - madly - - majestically - - meaningfully - - mechanically - - merrily - - miserably - - mockingly - - mortally - - mysteriously - - naturally - - nearly - - neatly - - nervously - - nicely - - noisily - - obediently - - obnoxiously - - oddly - - offensively - - optimistically - - overconfidently - - painfully - - partially - - patiently - - perfectly - - playfully - - politely - - poorly - - positively - - potentially - - powerfully - - promptly - - properly - - punctually - - quaintly - - queasily - - queerly - - questionably - - quickly - - quietly - - quirkily - - quizzically - - randomly - - rapidly - - rarely - - readily - - really - - reassuringly - - recklessly - - regularly - - reluctantly - - repeatedly - - reproachfully - - restfully - - righteously - - rightfully - - rigidly - - roughly - - rudely - - safely - - scarcely - - scarily - - searchingly - - sedately - - seemingly - - selfishly - - separately - - seriously - - shakily - - sharply - - sheepishly - - shrilly - - shyly - - silently - - sleepily - - slowly - - smoothly - - softly - - solemnly - - solidly - - speedily - - stealthily - - sternly - - strictly - - suddenly - - supposedly - - surprisingly - - suspiciously - - sweetly - - swiftly - - sympathetically - - tenderly - - tensely - - terribly - - thankfully - - thoroughly - - thoughtfully - - tightly - - tremendously - - triumphantly - - truthfully - - ultimately - - unabashedly - - unaccountably - - unbearably - - unethically - - unexpectedly - - unfortunately - - unimpressively - - unnaturally - - unnecessarily - - urgently - - usefully - - uselessly - - utterly - - vacantly - - vaguely - - vainly - - valiantly - - vastly - - verbally - - very - - viciously - - victoriously - - violently - - vivaciously - - voluntarily - - warmly - - weakly - - wearily - - wetly - - wholly - - wildly - - willfully - - wisely - - woefully - - wonderfully - - worriedly - - yawningly - - yearningly - - yieldingly - - youthfully - - zealously - - zestfully - - zestily diff --git a/portal/.vale-styles/Microsoft/Auto.yml b/portal/.vale-styles/Microsoft/Auto.yml deleted file mode 100644 index 4da43935..00000000 --- a/portal/.vale-styles/Microsoft/Auto.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "In general, don't hyphenate '%s'." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto -ignorecase: true -level: error -action: - name: convert - params: - - simple -tokens: - - 'auto-\w+' diff --git a/portal/.vale-styles/Microsoft/Avoid.yml b/portal/.vale-styles/Microsoft/Avoid.yml deleted file mode 100644 index dab7822c..00000000 --- a/portal/.vale-styles/Microsoft/Avoid.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "Don't use '%s'. See the A-Z word list for details." -# See the A-Z word list -link: https://docs.microsoft.com/en-us/style-guide -ignorecase: true -level: error -tokens: - - abortion - - and so on - - app(?:lication)?s? (?:developer|program) - - app(?:lication)? file - - backbone - - backend - - contiguous selection diff --git a/portal/.vale-styles/Microsoft/ComplexWords.yml b/portal/.vale-styles/Microsoft/ComplexWords.yml deleted file mode 100644 index 65b7a347..00000000 --- a/portal/.vale-styles/Microsoft/ComplexWords.yml +++ /dev/null @@ -1,120 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: suggestion -action: - name: replace -swap: - "approximate(?:ly)?": about - abundance: plenty - accelerate: speed up - accentuate: stress - accompany: go with - accomplish: carry out|do - accorded: given - accordingly: so - accrue: add - accurate: right|exact - acquiesce: agree - acquire: get|buy - additional: more|extra - address: discuss - addressees: you - adjacent to: next to - adjustment: change - admissible: allowed - advantageous: helpful - advise: tell - aggregate: total - aircraft: plane - alleviate: ease - allocate: assign|divide - alternatively: or - alternatives: choices|options - ameliorate: improve - amend: change - anticipate: expect - apparent: clear|plain - ascertain: discover|find out - assistance: help - attain: meet - attempt: try - authorize: allow - belated: late - bestow: give - cease: stop|end - collaborate: work together - commence: begin - compensate: pay - component: part - comprise: form|include - concept: idea - concerning: about - confer: give|award - consequently: so - consolidate: merge - constitutes: forms - contains: has - convene: meet - demonstrate: show|prove - depart: leave - designate: choose - desire: want|wish - determine: decide|find - detrimental: bad|harmful - disclose: share|tell - discontinue: stop - disseminate: send|give - eliminate: end - elucidate: explain - employ: use - enclosed: inside|included - encounter: meet - endeavor: try - enumerate: count - equitable: fair - equivalent: equal - exclusively: only - expedite: hurry - facilitate: ease - females: women - finalize: complete|finish - frequently: often - identical: same - incorrect: wrong - indication: sign - initiate: start|begin - itemized: listed - jeopardize: risk - liaise: work with|partner with - maintain: keep|support - methodology: method - modify: change - monitor: check|watch - multiple: many - necessitate: cause - notify: tell - numerous: many - objective: aim|goal - obligate: bind|compel - optimum: best|most - permit: let - portion: part - possess: own - previous: earlier - previously: before - prioritize: rank - procure: buy - provide: give|offer - purchase: buy - relocate: move - solicit: request - state-of-the-art: latest - subsequent: later|next - substantial: large - sufficient: enough - terminate: end - transmit: send - utilization: use - utilize: use diff --git a/portal/.vale-styles/Microsoft/Contractions.yml b/portal/.vale-styles/Microsoft/Contractions.yml deleted file mode 100644 index ded330f7..00000000 --- a/portal/.vale-styles/Microsoft/Contractions.yml +++ /dev/null @@ -1,50 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions -level: error -ignorecase: true -action: - name: replace -swap: - are not: aren't - cannot: can't - could not: couldn't - did not: didn't - do not: don't - does not: doesn't - has not: hasn't - have not: haven't - how is: how's - is not: isn't - - 'it is(?!\.)': it's - 'it''s(?=\.)': it is - - should not: shouldn't - - 'that is(?!\.)': that's - 'that''s(?=\.)': that is - - 'they are(?!\.)': they're - 'they''re(?=\.)': they are - - was not: wasn't - - 'we are(?!\.)': we're - 'we''re(?=\.)': we are - - 'we have(?!\.)': we've - 'we''ve(?=\.)': we have - - were not: weren't - - 'what is(?!\.)': what's - 'what''s(?=\.)': what is - - 'when is(?!\.)': when's - 'when''s(?=\.)': when is - - 'where is(?!\.)': where's - 'where''s(?=\.)': where is - - will not: won't diff --git a/portal/.vale-styles/Microsoft/Dashes.yml b/portal/.vale-styles/Microsoft/Dashes.yml deleted file mode 100644 index 2894cf72..00000000 --- a/portal/.vale-styles/Microsoft/Dashes.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Remove the spaces around '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes -ignorecase: true -nonword: true -level: error -action: - name: edit - params: - - remove - - ' ' -tokens: - - '[—–]\s|\s[—–]' diff --git a/portal/.vale-styles/Microsoft/DateFormat.yml b/portal/.vale-styles/Microsoft/DateFormat.yml deleted file mode 100644 index 19653139..00000000 --- a/portal/.vale-styles/Microsoft/DateFormat.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: Use 'July 31, 2016' format, not '%s'. -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms -ignorecase: true -level: error -nonword: true -tokens: - - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/portal/.vale-styles/Microsoft/DateNumbers.yml b/portal/.vale-styles/Microsoft/DateNumbers.yml deleted file mode 100644 index 14d46747..00000000 --- a/portal/.vale-styles/Microsoft/DateNumbers.yml +++ /dev/null @@ -1,40 +0,0 @@ -extends: existence -message: "Don't use ordinal numbers for dates." -link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates -level: error -nonword: true -ignorecase: true -raw: - - \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s* -tokens: - - first - - second - - third - - fourth - - fifth - - sixth - - seventh - - eighth - - ninth - - tenth - - eleventh - - twelfth - - thirteenth - - fourteenth - - fifteenth - - sixteenth - - seventeenth - - eighteenth - - nineteenth - - twentieth - - twenty-first - - twenty-second - - twenty-third - - twenty-fourth - - twenty-fifth - - twenty-sixth - - twenty-seventh - - twenty-eighth - - twenty-ninth - - thirtieth - - thirty-first diff --git a/portal/.vale-styles/Microsoft/DateOrder.yml b/portal/.vale-styles/Microsoft/DateOrder.yml deleted file mode 100644 index 12d69ba5..00000000 --- a/portal/.vale-styles/Microsoft/DateOrder.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Always spell out the name of the month." -link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates -ignorecase: true -level: error -nonword: true -tokens: - - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b' diff --git a/portal/.vale-styles/Microsoft/Ellipses.yml b/portal/.vale-styles/Microsoft/Ellipses.yml deleted file mode 100644 index 320457a8..00000000 --- a/portal/.vale-styles/Microsoft/Ellipses.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "In general, don't use an ellipsis." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses -nonword: true -level: warning -action: - name: remove -tokens: - - '\.\.\.' diff --git a/portal/.vale-styles/Microsoft/FirstPerson.yml b/portal/.vale-styles/Microsoft/FirstPerson.yml deleted file mode 100644 index 77761af8..00000000 --- a/portal/.vale-styles/Microsoft/FirstPerson.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: existence -message: "Use first person (such as '%s') sparingly." -link: https://docs.microsoft.com/en-us/style-guide/grammar/person -ignorecase: true -level: warning -nonword: true -tokens: - - (?:^|\s)I\s - - (?:^|\s)I,\s - - \bI'd\b - - \bI'll\b - - \bI'm\b - - \bI've\b - - \bme\b - - \bmy\b - - \bmine\b diff --git a/portal/.vale-styles/Microsoft/Foreign.yml b/portal/.vale-styles/Microsoft/Foreign.yml deleted file mode 100644 index d37835a5..00000000 --- a/portal/.vale-styles/Microsoft/Foreign.yml +++ /dev/null @@ -1,12 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words -ignorecase: true -level: error -nonword: true -action: - name: replace -swap: - '\b(?:eg|e\.g\.)[\s,]': for example - '\b(?:ie|i\.e\.)[\s,]': that is - diff --git a/portal/.vale-styles/Microsoft/Gender.yml b/portal/.vale-styles/Microsoft/Gender.yml deleted file mode 100644 index 47c08024..00000000 --- a/portal/.vale-styles/Microsoft/Gender.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Don't use '%s'." -link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender -level: error -ignorecase: true -tokens: - - he/she - - s/he diff --git a/portal/.vale-styles/Microsoft/GenderBias.yml b/portal/.vale-styles/Microsoft/GenderBias.yml deleted file mode 100644 index 3d873aa3..00000000 --- a/portal/.vale-styles/Microsoft/GenderBias.yml +++ /dev/null @@ -1,44 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -ignorecase: true -level: error -swap: - (?:alumna|alumnus): graduate - (?:alumnae|alumni): graduates - air(?:m[ae]n|wom[ae]n): pilot(s) - anchor(?:m[ae]n|wom[ae]n): anchor(s) - authoress: author - camera(?:m[ae]n|wom[ae]n): camera operator(s) - chair(?:m[ae]n|wom[ae]n): chair(s) - congress(?:m[ae]n|wom[ae]n): member(s) of congress - door(?:m[ae]|wom[ae]n): concierge(s) - draft(?:m[ae]n|wom[ae]n): drafter(s) - fire(?:m[ae]n|wom[ae]n): firefighter(s) - fisher(?:m[ae]n|wom[ae]n): fisher(s) - fresh(?:m[ae]n|wom[ae]n): first-year student(s) - garbage(?:m[ae]n|wom[ae]n): waste collector(s) - lady lawyer: lawyer - ladylike: courteous - landlord: building manager - mail(?:m[ae]n|wom[ae]n): mail carriers - man and wife: husband and wife - man enough: strong enough - mankind: human kind - manmade: manufactured - manpower: personnel - men and girls: men and women - middle(?:m[ae]n|wom[ae]n): intermediary - news(?:m[ae]n|wom[ae]n): journalist(s) - ombuds(?:man|woman): ombuds - oneupmanship: upstaging - poetess: poet - police(?:m[ae]n|wom[ae]n): police officer(s) - repair(?:m[ae]n|wom[ae]n): technician(s) - sales(?:m[ae]n|wom[ae]n): salesperson or sales people - service(?:m[ae]n|wom[ae]n): soldier(s) - steward(?:ess)?: flight attendant - tribes(?:m[ae]n|wom[ae]n): tribe member(s) - waitress: waiter - woman doctor: doctor - woman scientist[s]?: scientist(s) - work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/portal/.vale-styles/Microsoft/GeneralURL.yml b/portal/.vale-styles/Microsoft/GeneralURL.yml deleted file mode 100644 index dcef503d..00000000 --- a/portal/.vale-styles/Microsoft/GeneralURL.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "For a general audience, use 'address' rather than 'URL'." -link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses -level: warning -action: - name: replace - params: - - URL - - address -tokens: - - URL diff --git a/portal/.vale-styles/Microsoft/HeadingAcronyms.yml b/portal/.vale-styles/Microsoft/HeadingAcronyms.yml deleted file mode 100644 index 6c91e662..00000000 --- a/portal/.vale-styles/Microsoft/HeadingAcronyms.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "Avoid using acronyms in a title or heading." -link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acronyms-in-titles-and-headings -level: warning -scope: heading -tokens: - - '[A-Z]{2,4}' -exceptions: - - SDK - - AD - - SAS - - BOM - - JMS - - API diff --git a/portal/.vale-styles/Microsoft/HeadingColons.yml b/portal/.vale-styles/Microsoft/HeadingColons.yml deleted file mode 100644 index 7013c391..00000000 --- a/portal/.vale-styles/Microsoft/HeadingColons.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Capitalize '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons -nonword: true -level: error -scope: heading -tokens: - - ':\s[a-z]' diff --git a/portal/.vale-styles/Microsoft/HeadingPunctuation.yml b/portal/.vale-styles/Microsoft/HeadingPunctuation.yml deleted file mode 100644 index af04b02e..00000000 --- a/portal/.vale-styles/Microsoft/HeadingPunctuation.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't use end punctuation in headings." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -nonword: true -level: warning -scope: heading -action: - name: edit - params: - - remove - - '.?!' -tokens: - - '[a-z][.?!](?:\s|$)' diff --git a/portal/.vale-styles/Microsoft/Headings.yml b/portal/.vale-styles/Microsoft/Headings.yml deleted file mode 100644 index 63624edc..00000000 --- a/portal/.vale-styles/Microsoft/Headings.yml +++ /dev/null @@ -1,28 +0,0 @@ -extends: capitalization -message: "'%s' should use sentence-style capitalization." -link: https://docs.microsoft.com/en-us/style-guide/capitalization -level: suggestion -scope: heading -match: $sentence -indicators: - - ':' -exceptions: - - Azure - - CLI - - Code - - Cosmos - - Docker - - Emmet - - I - - Kubernetes - - Linux - - macOS - - Marketplace - - MongoDB - - REPL - - Studio - - TypeScript - - URLs - - Visual - - VS - - Windows diff --git a/portal/.vale-styles/Microsoft/Hyphens.yml b/portal/.vale-styles/Microsoft/Hyphens.yml deleted file mode 100644 index 90bbb5de..00000000 --- a/portal/.vale-styles/Microsoft/Hyphens.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "'%s' doesn't need a hyphen." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens -level: warning -ignorecase: false -nonword: true -action: - name: edit - params: - - replace - - '-' - - ' ' -tokens: - - '\s[^\s-]+ly-' diff --git a/portal/.vale-styles/Microsoft/Negative.yml b/portal/.vale-styles/Microsoft/Negative.yml deleted file mode 100644 index d6ff2f22..00000000 --- a/portal/.vale-styles/Microsoft/Negative.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Form a negative number with an en dash, not a hyphen." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '-' - - '–' -tokens: - - '\s-\d+\s' diff --git a/portal/.vale-styles/Microsoft/Ordinal.yml b/portal/.vale-styles/Microsoft/Ordinal.yml deleted file mode 100644 index e3483e38..00000000 --- a/portal/.vale-styles/Microsoft/Ordinal.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't add -ly to an ordinal number." -link: https://docs.microsoft.com/en-us/style-guide/numbers -level: error -action: - name: edit - params: - - trim - - ly -tokens: - - firstly - - secondly - - thirdly diff --git a/portal/.vale-styles/Microsoft/OxfordComma.yml b/portal/.vale-styles/Microsoft/OxfordComma.yml deleted file mode 100644 index 493b55c3..00000000 --- a/portal/.vale-styles/Microsoft/OxfordComma.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Use the Oxford comma in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas -scope: sentence -level: suggestion -nonword: true -tokens: - - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' diff --git a/portal/.vale-styles/Microsoft/Passive.yml b/portal/.vale-styles/Microsoft/Passive.yml deleted file mode 100644 index 102d377c..00000000 --- a/portal/.vale-styles/Microsoft/Passive.yml +++ /dev/null @@ -1,183 +0,0 @@ -extends: existence -message: "'%s' looks like passive voice." -ignorecase: true -level: suggestion -raw: - - \b(am|are|were|being|is|been|was|be)\b\s* -tokens: - - '[\w]+ed' - - awoken - - beat - - become - - been - - begun - - bent - - beset - - bet - - bid - - bidden - - bitten - - bled - - blown - - born - - bought - - bound - - bred - - broadcast - - broken - - brought - - built - - burnt - - burst - - cast - - caught - - chosen - - clung - - come - - cost - - crept - - cut - - dealt - - dived - - done - - drawn - - dreamt - - driven - - drunk - - dug - - eaten - - fallen - - fed - - felt - - fit - - fled - - flown - - flung - - forbidden - - foregone - - forgiven - - forgotten - - forsaken - - fought - - found - - frozen - - given - - gone - - gotten - - ground - - grown - - heard - - held - - hidden - - hit - - hung - - hurt - - kept - - knelt - - knit - - known - - laid - - lain - - leapt - - learnt - - led - - left - - lent - - let - - lighted - - lost - - made - - meant - - met - - misspelt - - mistaken - - mown - - overcome - - overdone - - overtaken - - overthrown - - paid - - pled - - proven - - put - - quit - - read - - rid - - ridden - - risen - - run - - rung - - said - - sat - - sawn - - seen - - sent - - set - - sewn - - shaken - - shaven - - shed - - shod - - shone - - shorn - - shot - - shown - - shrunk - - shut - - slain - - slept - - slid - - slit - - slung - - smitten - - sold - - sought - - sown - - sped - - spent - - spilt - - spit - - split - - spoken - - spread - - sprung - - spun - - stolen - - stood - - stridden - - striven - - struck - - strung - - stuck - - stung - - stunk - - sung - - sunk - - swept - - swollen - - sworn - - swum - - swung - - taken - - taught - - thought - - thrived - - thrown - - thrust - - told - - torn - - trodden - - understood - - upheld - - upset - - wed - - wept - - withheld - - withstood - - woken - - won - - worn - - wound - - woven - - written - - wrung diff --git a/portal/.vale-styles/Microsoft/Percentages.yml b/portal/.vale-styles/Microsoft/Percentages.yml deleted file mode 100644 index b68a7363..00000000 --- a/portal/.vale-styles/Microsoft/Percentages.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use a numeral plus the units." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -tokens: - - '\b[a-zA-z]+\spercent\b' diff --git a/portal/.vale-styles/Microsoft/Quotes.yml b/portal/.vale-styles/Microsoft/Quotes.yml deleted file mode 100644 index 38f49760..00000000 --- a/portal/.vale-styles/Microsoft/Quotes.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: 'Punctuation should be inside the quotes.' -link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks -level: error -nonword: true -tokens: - - '["“][^"”“]+["”][.,]' diff --git a/portal/.vale-styles/Microsoft/RangeFormat.yml b/portal/.vale-styles/Microsoft/RangeFormat.yml deleted file mode 100644 index f1d736e9..00000000 --- a/portal/.vale-styles/Microsoft/RangeFormat.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Use an en dash in a range of numbers." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '-' - - '–' -tokens: - - '\b\d+\s?[-]\s?\d+\b' diff --git a/portal/.vale-styles/Microsoft/RangeTime.yml b/portal/.vale-styles/Microsoft/RangeTime.yml deleted file mode 100644 index cdd4b334..00000000 --- a/portal/.vale-styles/Microsoft/RangeTime.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Use 'to' instead of a dash in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '[-–]' - - 'to' -tokens: - - '\b(?:AM|PM)\s?[-–]\s?.+(?:AM|PM)\b' diff --git a/portal/.vale-styles/Microsoft/Ranges.yml b/portal/.vale-styles/Microsoft/Ranges.yml deleted file mode 100644 index 67d9702b..00000000 --- a/portal/.vale-styles/Microsoft/Ranges.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "In most cases, use 'from' or 'through' to describe a range of numbers." -link: 'https://docs.microsoft.com/en-us/style-guide/numbers' -nonword: true -level: warning -tokens: - - '\b\d+\s?[-–]\s?\d+\b' diff --git a/portal/.vale-styles/Microsoft/Semicolon.yml b/portal/.vale-styles/Microsoft/Semicolon.yml deleted file mode 100644 index 4d905467..00000000 --- a/portal/.vale-styles/Microsoft/Semicolon.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Try to simplify this sentence." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/semicolons -nonword: true -scope: sentence -level: suggestion -tokens: - - ';' diff --git a/portal/.vale-styles/Microsoft/SentenceLength.yml b/portal/.vale-styles/Microsoft/SentenceLength.yml deleted file mode 100644 index f248cf05..00000000 --- a/portal/.vale-styles/Microsoft/SentenceLength.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: occurrence -message: "Try to keep sentences short (< 30 words)." -scope: sentence -level: suggestion -max: 30 -token: \b(\w+)\b - diff --git a/portal/.vale-styles/Microsoft/Spacing.yml b/portal/.vale-styles/Microsoft/Spacing.yml deleted file mode 100644 index 4189306f..00000000 --- a/portal/.vale-styles/Microsoft/Spacing.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: existence -message: "'%s' should have one space." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -level: error -nonword: true -tokens: - - '[a-z][.?!] {2,}[A-Z]' - - '[a-z][.?!][A-Z]' -exceptions: - - \ No newline at end of file diff --git a/portal/.vale-styles/Microsoft/Suspended.yml b/portal/.vale-styles/Microsoft/Suspended.yml deleted file mode 100644 index 7282e9c9..00000000 --- a/portal/.vale-styles/Microsoft/Suspended.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't use '%s' unless space is limited." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens -ignorecase: true -level: warning -tokens: - - '\w+- and \w+-' diff --git a/portal/.vale-styles/Microsoft/Terms.yml b/portal/.vale-styles/Microsoft/Terms.yml deleted file mode 100644 index e41ff74b..00000000 --- a/portal/.vale-styles/Microsoft/Terms.yml +++ /dev/null @@ -1,43 +0,0 @@ -extends: substitution -message: "Prefer '%s' over '%s'." -level: warning -ignorecase: true -action: - name: replace -swap: - '(?:agent|virtual assistant|intelligent personal assistant)': personal digital assistant - '(?:drive C:|drive C>|C: drive)': drive C - '(?:internet bot|web robot)s?': bot(s) - '(?:microsoft cloud|the cloud)': cloud - '(?:mobile|smart) ?phone': phone - '24/7': every day - 'audio(?:-| )book': audiobook - 'back(?:-| )light': backlight - 'chat ?bots?': chatbot(s) - adaptor: adapter - administrate: administer - afterwards: afterward - alphabetic: alphabetical - alphanumerical: alphanumeric - anti-aliasing: antialiasing - anti-malware: antimalware - anti-spyware: antispyware - anti-virus: antivirus - appendixes: appendices - artificial intelligence: artificial intelligence - assembler: assembly language - bpp: bpp - bps: bps - caap: CaaP - conversation-as-a-platform: conversation as a platform - eb: EB - gb: GB - gbps: Gbps - kb: KB - keypress: keystroke - mb: MB - pb: PB - tb: TB - zb: ZB - viz: namely - ergo: therefore diff --git a/portal/.vale-styles/Microsoft/URLFormat.yml b/portal/.vale-styles/Microsoft/URLFormat.yml deleted file mode 100644 index 82e702f9..00000000 --- a/portal/.vale-styles/Microsoft/URLFormat.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -ignorecase: true -level: error -action: - name: replace -swap: - URL for: URL of - an URL: a URL - diff --git a/portal/.vale-styles/Microsoft/Units.yml b/portal/.vale-styles/Microsoft/Units.yml deleted file mode 100644 index f062418e..00000000 --- a/portal/.vale-styles/Microsoft/Units.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: existence -message: "Don't spell out the number in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/units-of-measure-terms -level: error -raw: - - '[a-zA-Z]+\s' -tokens: - - '(?:centi|milli)?meters' - - '(?:kilo)?grams' - - '(?:kilo)?meters' - - '(?:mega)?pixels' - - cm - - inches - - lb - - miles - - pounds diff --git a/portal/.vale-styles/Microsoft/Vocab.yml b/portal/.vale-styles/Microsoft/Vocab.yml deleted file mode 100644 index eebe97b1..00000000 --- a/portal/.vale-styles/Microsoft/Vocab.yml +++ /dev/null @@ -1,25 +0,0 @@ -extends: existence -message: "Verify your use of '%s' with the A-Z word list." -link: 'https://docs.microsoft.com/en-us/style-guide' -level: suggestion -ignorecase: true -tokens: - - above - - accessible - - actionable - - against - - alarm - - alert - - alias - - allows? - - and/or - - as well as - - assure - - author - - avg - - beta - - ensure - - he - - insure - - sample - - she diff --git a/portal/.vale-styles/Microsoft/We.yml b/portal/.vale-styles/Microsoft/We.yml deleted file mode 100644 index 97c901c1..00000000 --- a/portal/.vale-styles/Microsoft/We.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Try to avoid using first-person plural like '%s'." -link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural -level: warning -ignorecase: true -tokens: - - we - - we'(?:ve|re) - - ours? - - us - - let's diff --git a/portal/.vale-styles/Microsoft/Wordiness.yml b/portal/.vale-styles/Microsoft/Wordiness.yml deleted file mode 100644 index 22a4c932..00000000 --- a/portal/.vale-styles/Microsoft/Wordiness.yml +++ /dev/null @@ -1,122 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: warning -action: - name: replace -swap: - (?:give|gave) rise to: lead to - (?:previous|prior) to: before - a (?:large)? majority of: most - a (?:large)? number of: many - a myriad of: myriad - adversely impact: hurt - all across: across - all of a sudden: suddenly - all of these: these - all of: all - all-time record: record - almost all: most - almost never: seldom - along the lines of: similar to - an adequate number of: enough - an appreciable number of: many - an estimated: about - any and all: all - are in agreement: agree - as a matter of fact: in fact - as a means of: to - as a result of: because of - as of yet: yet - as per: per - at a later date: later - at all times: always - at the present time: now - at this point in time: at this point - based in large part on: based on - based on the fact that: because - basic necessity: necessity - because of the fact that: because - came to a realization: realized - came to an abrupt end: ended abruptly - carry out an evaluation of: evaluate - close down: close - closed down: closed - complete stranger: stranger - completely separate: separate - concerning the matter of: regarding - conduct a review of: review - conduct an investigation: investigate - conduct experiments: experiment - continue on: continue - despite the fact that: although - disappear from sight: disappear - drag and drop: drag - drag-and-drop: drag - doomed to fail: doomed - due to the fact that: because - during the period of: during - during the time that: while - emergency situation: emergency - except when: unless - excessive number: too many - extend an invitation: invite - fall down: fall - fell down: fell - for the duration of: during - gather together: gather - has the ability to: can - has the capacity to: can - has the opportunity to: could - hold a meeting: meet - if this is not the case: if not - in a careful manner: carefully - in a thoughtful manner: thoughtfully - in a timely manner: timely - in an effort to: to - in between: between - in lieu of: instead of - in many cases: often - in most cases: usually - in order to: to - in some cases: sometimes - in spite of the fact that: although - in spite of: despite - in the (?:very)? near future: soon - in the event that: if - in the neighborhood of: roughly - in the vicinity of: close to - it would appear that: apparently - lift up: lift - made reference to: referred to - make reference to: refer to - mix together: mix - none at all: none - not in a position to: unable - not possible: impossible - of major importance: important - perform an assessment of: assess - pertaining to: about - place an order: order - plays a key role in: is essential to - present time: now - readily apparent: apparent - some of the: some - span across: span - subsequent to: after - successfully complete: complete - sufficient number (?:of)?: enough - take action: act - take into account: consider - the question as to whether: whether - there is no doubt but that: doubtless - this day and age: this age - this is a subject that: this subject - time (?:frame|period): time - under the provisions of: under - until such time as: until - used for fuel purposes: used for fuel - whether or not: whether - with regard to: regarding - with the exception of: except for diff --git a/portal/.vale-styles/Microsoft/meta.json b/portal/.vale-styles/Microsoft/meta.json deleted file mode 100644 index 297719bb..00000000 --- a/portal/.vale-styles/Microsoft/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/errata-ai/Microsoft/releases.atom", - "vale_version": ">=1.0.0" -} diff --git a/portal/.vale.ini b/portal/.vale.ini deleted file mode 100644 index 6574c688..00000000 --- a/portal/.vale.ini +++ /dev/null @@ -1,20 +0,0 @@ -# Core properties -#---------------- -# Specify where to find styles -StylesPath = .vale-styles - -# Specify the minimum alert level to report -# Alerts are assigned a level of suggestion, warning, or error. -# For local use it's good to see all the suggestions and warnings. -MinAlertLevel = suggestion - -# Specify how to test a particular type of files -#----------------------------------------------- -[*.{adoc,md}] - -# Vale comes with three built-in styles: write-good, proselint, and Joblint. -# You could enable all rules in the "Microsoft" style guide as follows: -# BasedOnStyles = Microsoft -BasedOnStyles = Microsoft - -Microsoft.Headings = NO diff --git a/portal/README.adoc b/portal/README.adoc deleted file mode 100644 index a83ae683..00000000 --- a/portal/README.adoc +++ /dev/null @@ -1 +0,0 @@ -This project is used to manage docs displayed in the https://microsoft.github.io/spring-cloud-azure[GitHub Pages] \ No newline at end of file diff --git a/portal/pom.xml b/portal/pom.xml deleted file mode 100644 index 3bacac85..00000000 --- a/portal/pom.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - 4.0.0 - - - com.azure.spring - spring-cloud-azure-docs - 4.1.0-beta.1 - ../pom.xml - - - spring-cloud-azure-docs-portal - spring-cloud-azure-docs-portal - - - ${project.build.directory}/generated-docs/${project.version}/portal/html - - - diff --git a/portal/src/main/.gitignore b/portal/src/main/.gitignore deleted file mode 100644 index acf32da4..00000000 --- a/portal/src/main/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -META-INF/ -org/ \ No newline at end of file diff --git a/portal/src/main/asciidoc/_attributes.adoc b/portal/src/main/asciidoc/_attributes.adoc deleted file mode 100644 index 201f33bb..00000000 --- a/portal/src/main/asciidoc/_attributes.adoc +++ /dev/null @@ -1,16 +0,0 @@ -:doctype: book -:idprefix: -:idseparator: - -:toc: left -:toclevels: 4 -:tabsize: 4 -:numbered: -:sectanchors: -:sectnums: -:icons: font -:hide-uri-scheme: -:docinfo: shared,private - -:sc-ext: java -:project-full-name: Spring Cloud Azure -:all: {asterisk}{asterisk} diff --git a/portal/src/main/asciidoc/docinfo.html b/portal/src/main/asciidoc/docinfo.html deleted file mode 100644 index 1b364b3c..00000000 --- a/portal/src/main/asciidoc/docinfo.html +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/portal/src/main/asciidoc/index.adoc b/portal/src/main/asciidoc/index.adoc deleted file mode 100644 index 56033fdd..00000000 --- a/portal/src/main/asciidoc/index.adoc +++ /dev/null @@ -1,18 +0,0 @@ -include::_attributes.adoc[] - -= Portal - -Spring Cloud Azure Documentation consists of the following sections: - - -[%noheader,grid=none,frame=none,cols="<30,<70"] -|=== - -|link:/spring-cloud-azure/{project-version}/getting-started/html/index.html[Getting Started] |Getting Started Guides - -|link:/spring-cloud-azure/{project-version}/reference/html/index.html[Reference] |Reference Documentation - -|link:/spring-cloud-azure/{project-version}/samples/html/index.html[Samples] |Samples - -|link:/spring-cloud-azure/{project-version}/tutorials/html/index.html[Tutorials] |Tutorials -|=== \ No newline at end of file diff --git a/reference/.vale-styles/Microsoft/AMPM.yml b/reference/.vale-styles/Microsoft/AMPM.yml deleted file mode 100644 index 8b9fed16..00000000 --- a/reference/.vale-styles/Microsoft/AMPM.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: Use 'AM' or 'PM' (preceded by a space). -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms -level: error -nonword: true -tokens: - - '\d{1,2}[AP]M' - - '\d{1,2} ?[ap]m' - - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/reference/.vale-styles/Microsoft/Accessibility.yml b/reference/.vale-styles/Microsoft/Accessibility.yml deleted file mode 100644 index 05bf9273..00000000 --- a/reference/.vale-styles/Microsoft/Accessibility.yml +++ /dev/null @@ -1,25 +0,0 @@ -extends: existence -message: "Don't use language (such as '%s') that defines people by their disability." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms -level: suggestion -ignorecase: true -tokens: - - a victim of - - able-bodied - - affected by - - an epileptic - - crippled - - disabled - - dumb - - handicapped - - handicaps - - healthy - - lame - - maimed - - missing a limb - - mute - - normal - - sight-impaired - - stricken with - - suffers from - - vision-impaired diff --git a/reference/.vale-styles/Microsoft/Acronyms.yml b/reference/.vale-styles/Microsoft/Acronyms.yml deleted file mode 100644 index 82f240ab..00000000 --- a/reference/.vale-styles/Microsoft/Acronyms.yml +++ /dev/null @@ -1,73 +0,0 @@ -extends: conditional -message: "'%s' has no definition." -link: https://docs.microsoft.com/en-us/style-guide/acronyms -level: suggestion -ignorecase: false -# Ensures that the existence of 'first' implies the existence of 'second'. -first: '\b([A-Z]{3,5})\b' -second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' -# ... with the exception of these: -exceptions: - - API - - ASP - - CLI - - CPU - - CSS - - CSV - - DEBUG - - DOM - - DPI - - FAQ - - GCC - - GDB - - GET - - GPU - - GTK - - GUI - - HTML - - HTTP - - HTTPS - - IDE - - JAR - - JSON - - JSX - - LESS - - LLDB - - NET - - NOTE - - NVDA - - OSS - - PATH - - PDF - - PHP - - POST - - RAM - - REPL - - RSA - - SCM - - SCSS - - SDK - - SQL - - SSH - - SSL - - SVG - - TBD - - TCP - - TODO - - URI - - URL - - USB - - UTF - - XML - - XSS - - YAML - - ZIP - - BOM - - AMQP - - AAD - - POSIX - - AKS - - PEM - - CRUD - - SAS - - JMS diff --git a/reference/.vale-styles/Microsoft/Adverbs.yml b/reference/.vale-styles/Microsoft/Adverbs.yml deleted file mode 100644 index 07d98d83..00000000 --- a/reference/.vale-styles/Microsoft/Adverbs.yml +++ /dev/null @@ -1,270 +0,0 @@ -extends: existence -message: "Consider removing '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: warning -action: - name: remove -tokens: - - abnormally - - absentmindedly - - accidentally - - adventurously - - anxiously - - arrogantly - - awkwardly - - bashfully - - beautifully - - bitterly - - bleakly - - blindly - - blissfully - - boastfully - - boldly - - bravely - - briefly - - brightly - - briskly - - broadly - - busily - - calmly - - carefully - - carelessly - - cautiously - - cheerfully - - cleverly - - closely - - coaxingly - - colorfully - - continually - - coolly - - courageously - - crossly - - cruelly - - curiously - - daintily - - dearly - - deceivingly - - deeply - - defiantly - - deliberately - - delightfully - - diligently - - dimly - - doubtfully - - dreamily - - easily - - elegantly - - energetically - - enormously - - enthusiastically - - excitedly - - extremely - - fairly - - faithfully - - famously - - ferociously - - fervently - - fiercely - - fondly - - foolishly - - fortunately - - frankly - - frantically - - freely - - frenetically - - frightfully - - furiously - - generally - - generously - - gently - - gladly - - gleefully - - gracefully - - gratefully - - greatly - - greedily - - happily - - hastily - - healthily - - heavily - - helplessly - - honestly - - hopelessly - - hungrily - - innocently - - inquisitively - - intensely - - intently - - interestingly - - inwardly - - irritably - - jaggedly - - jealously - - jovially - - joyfully - - joyously - - jubilantly - - judgmentally - - justly - - keenly - - kiddingly - - kindheartedly - - knavishly - - knowingly - - knowledgeably - - lazily - - lightly - - limply - - lively - - loftily - - longingly - - loosely - - loudly - - lovingly - - loyally - - madly - - majestically - - meaningfully - - mechanically - - merrily - - miserably - - mockingly - - mortally - - mysteriously - - naturally - - nearly - - neatly - - nervously - - nicely - - noisily - - obediently - - obnoxiously - - oddly - - offensively - - optimistically - - overconfidently - - painfully - - partially - - patiently - - perfectly - - playfully - - politely - - poorly - - positively - - potentially - - powerfully - - promptly - - properly - - punctually - - quaintly - - queasily - - queerly - - questionably - - quickly - - quietly - - quirkily - - quizzically - - randomly - - rapidly - - rarely - - readily - - really - - reassuringly - - recklessly - - regularly - - reluctantly - - repeatedly - - reproachfully - - restfully - - righteously - - rightfully - - rigidly - - roughly - - rudely - - safely - - scarcely - - scarily - - searchingly - - sedately - - seemingly - - selfishly - - separately - - seriously - - shakily - - sharply - - sheepishly - - shrilly - - shyly - - silently - - sleepily - - slowly - - smoothly - - softly - - solemnly - - solidly - - speedily - - stealthily - - sternly - - strictly - - suddenly - - supposedly - - surprisingly - - suspiciously - - sweetly - - swiftly - - sympathetically - - tenderly - - tensely - - terribly - - thankfully - - thoroughly - - thoughtfully - - tightly - - tremendously - - triumphantly - - truthfully - - ultimately - - unabashedly - - unaccountably - - unbearably - - unethically - - unexpectedly - - unfortunately - - unimpressively - - unnaturally - - unnecessarily - - urgently - - usefully - - uselessly - - utterly - - vacantly - - vaguely - - vainly - - valiantly - - vastly - - verbally - - very - - viciously - - victoriously - - violently - - vivaciously - - voluntarily - - warmly - - weakly - - wearily - - wetly - - wholly - - wildly - - willfully - - wisely - - woefully - - wonderfully - - worriedly - - yawningly - - yearningly - - yieldingly - - youthfully - - zealously - - zestfully - - zestily diff --git a/reference/.vale-styles/Microsoft/Auto.yml b/reference/.vale-styles/Microsoft/Auto.yml deleted file mode 100644 index 4da43935..00000000 --- a/reference/.vale-styles/Microsoft/Auto.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "In general, don't hyphenate '%s'." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto -ignorecase: true -level: error -action: - name: convert - params: - - simple -tokens: - - 'auto-\w+' diff --git a/reference/.vale-styles/Microsoft/Avoid.yml b/reference/.vale-styles/Microsoft/Avoid.yml deleted file mode 100644 index dab7822c..00000000 --- a/reference/.vale-styles/Microsoft/Avoid.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "Don't use '%s'. See the A-Z word list for details." -# See the A-Z word list -link: https://docs.microsoft.com/en-us/style-guide -ignorecase: true -level: error -tokens: - - abortion - - and so on - - app(?:lication)?s? (?:developer|program) - - app(?:lication)? file - - backbone - - backend - - contiguous selection diff --git a/reference/.vale-styles/Microsoft/ComplexWords.yml b/reference/.vale-styles/Microsoft/ComplexWords.yml deleted file mode 100644 index 65b7a347..00000000 --- a/reference/.vale-styles/Microsoft/ComplexWords.yml +++ /dev/null @@ -1,120 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: suggestion -action: - name: replace -swap: - "approximate(?:ly)?": about - abundance: plenty - accelerate: speed up - accentuate: stress - accompany: go with - accomplish: carry out|do - accorded: given - accordingly: so - accrue: add - accurate: right|exact - acquiesce: agree - acquire: get|buy - additional: more|extra - address: discuss - addressees: you - adjacent to: next to - adjustment: change - admissible: allowed - advantageous: helpful - advise: tell - aggregate: total - aircraft: plane - alleviate: ease - allocate: assign|divide - alternatively: or - alternatives: choices|options - ameliorate: improve - amend: change - anticipate: expect - apparent: clear|plain - ascertain: discover|find out - assistance: help - attain: meet - attempt: try - authorize: allow - belated: late - bestow: give - cease: stop|end - collaborate: work together - commence: begin - compensate: pay - component: part - comprise: form|include - concept: idea - concerning: about - confer: give|award - consequently: so - consolidate: merge - constitutes: forms - contains: has - convene: meet - demonstrate: show|prove - depart: leave - designate: choose - desire: want|wish - determine: decide|find - detrimental: bad|harmful - disclose: share|tell - discontinue: stop - disseminate: send|give - eliminate: end - elucidate: explain - employ: use - enclosed: inside|included - encounter: meet - endeavor: try - enumerate: count - equitable: fair - equivalent: equal - exclusively: only - expedite: hurry - facilitate: ease - females: women - finalize: complete|finish - frequently: often - identical: same - incorrect: wrong - indication: sign - initiate: start|begin - itemized: listed - jeopardize: risk - liaise: work with|partner with - maintain: keep|support - methodology: method - modify: change - monitor: check|watch - multiple: many - necessitate: cause - notify: tell - numerous: many - objective: aim|goal - obligate: bind|compel - optimum: best|most - permit: let - portion: part - possess: own - previous: earlier - previously: before - prioritize: rank - procure: buy - provide: give|offer - purchase: buy - relocate: move - solicit: request - state-of-the-art: latest - subsequent: later|next - substantial: large - sufficient: enough - terminate: end - transmit: send - utilization: use - utilize: use diff --git a/reference/.vale-styles/Microsoft/Contractions.yml b/reference/.vale-styles/Microsoft/Contractions.yml deleted file mode 100644 index ded330f7..00000000 --- a/reference/.vale-styles/Microsoft/Contractions.yml +++ /dev/null @@ -1,50 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions -level: error -ignorecase: true -action: - name: replace -swap: - are not: aren't - cannot: can't - could not: couldn't - did not: didn't - do not: don't - does not: doesn't - has not: hasn't - have not: haven't - how is: how's - is not: isn't - - 'it is(?!\.)': it's - 'it''s(?=\.)': it is - - should not: shouldn't - - 'that is(?!\.)': that's - 'that''s(?=\.)': that is - - 'they are(?!\.)': they're - 'they''re(?=\.)': they are - - was not: wasn't - - 'we are(?!\.)': we're - 'we''re(?=\.)': we are - - 'we have(?!\.)': we've - 'we''ve(?=\.)': we have - - were not: weren't - - 'what is(?!\.)': what's - 'what''s(?=\.)': what is - - 'when is(?!\.)': when's - 'when''s(?=\.)': when is - - 'where is(?!\.)': where's - 'where''s(?=\.)': where is - - will not: won't diff --git a/reference/.vale-styles/Microsoft/Dashes.yml b/reference/.vale-styles/Microsoft/Dashes.yml deleted file mode 100644 index 2894cf72..00000000 --- a/reference/.vale-styles/Microsoft/Dashes.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Remove the spaces around '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes -ignorecase: true -nonword: true -level: error -action: - name: edit - params: - - remove - - ' ' -tokens: - - '[—–]\s|\s[—–]' diff --git a/reference/.vale-styles/Microsoft/DateFormat.yml b/reference/.vale-styles/Microsoft/DateFormat.yml deleted file mode 100644 index 19653139..00000000 --- a/reference/.vale-styles/Microsoft/DateFormat.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: Use 'July 31, 2016' format, not '%s'. -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms -ignorecase: true -level: error -nonword: true -tokens: - - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/reference/.vale-styles/Microsoft/DateNumbers.yml b/reference/.vale-styles/Microsoft/DateNumbers.yml deleted file mode 100644 index 14d46747..00000000 --- a/reference/.vale-styles/Microsoft/DateNumbers.yml +++ /dev/null @@ -1,40 +0,0 @@ -extends: existence -message: "Don't use ordinal numbers for dates." -link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates -level: error -nonword: true -ignorecase: true -raw: - - \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s* -tokens: - - first - - second - - third - - fourth - - fifth - - sixth - - seventh - - eighth - - ninth - - tenth - - eleventh - - twelfth - - thirteenth - - fourteenth - - fifteenth - - sixteenth - - seventeenth - - eighteenth - - nineteenth - - twentieth - - twenty-first - - twenty-second - - twenty-third - - twenty-fourth - - twenty-fifth - - twenty-sixth - - twenty-seventh - - twenty-eighth - - twenty-ninth - - thirtieth - - thirty-first diff --git a/reference/.vale-styles/Microsoft/DateOrder.yml b/reference/.vale-styles/Microsoft/DateOrder.yml deleted file mode 100644 index 12d69ba5..00000000 --- a/reference/.vale-styles/Microsoft/DateOrder.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Always spell out the name of the month." -link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates -ignorecase: true -level: error -nonword: true -tokens: - - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b' diff --git a/reference/.vale-styles/Microsoft/Ellipses.yml b/reference/.vale-styles/Microsoft/Ellipses.yml deleted file mode 100644 index 320457a8..00000000 --- a/reference/.vale-styles/Microsoft/Ellipses.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "In general, don't use an ellipsis." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses -nonword: true -level: warning -action: - name: remove -tokens: - - '\.\.\.' diff --git a/reference/.vale-styles/Microsoft/FirstPerson.yml b/reference/.vale-styles/Microsoft/FirstPerson.yml deleted file mode 100644 index 77761af8..00000000 --- a/reference/.vale-styles/Microsoft/FirstPerson.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: existence -message: "Use first person (such as '%s') sparingly." -link: https://docs.microsoft.com/en-us/style-guide/grammar/person -ignorecase: true -level: warning -nonword: true -tokens: - - (?:^|\s)I\s - - (?:^|\s)I,\s - - \bI'd\b - - \bI'll\b - - \bI'm\b - - \bI've\b - - \bme\b - - \bmy\b - - \bmine\b diff --git a/reference/.vale-styles/Microsoft/Foreign.yml b/reference/.vale-styles/Microsoft/Foreign.yml deleted file mode 100644 index d37835a5..00000000 --- a/reference/.vale-styles/Microsoft/Foreign.yml +++ /dev/null @@ -1,12 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words -ignorecase: true -level: error -nonword: true -action: - name: replace -swap: - '\b(?:eg|e\.g\.)[\s,]': for example - '\b(?:ie|i\.e\.)[\s,]': that is - diff --git a/reference/.vale-styles/Microsoft/Gender.yml b/reference/.vale-styles/Microsoft/Gender.yml deleted file mode 100644 index 47c08024..00000000 --- a/reference/.vale-styles/Microsoft/Gender.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Don't use '%s'." -link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender -level: error -ignorecase: true -tokens: - - he/she - - s/he diff --git a/reference/.vale-styles/Microsoft/GenderBias.yml b/reference/.vale-styles/Microsoft/GenderBias.yml deleted file mode 100644 index 3d873aa3..00000000 --- a/reference/.vale-styles/Microsoft/GenderBias.yml +++ /dev/null @@ -1,44 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -ignorecase: true -level: error -swap: - (?:alumna|alumnus): graduate - (?:alumnae|alumni): graduates - air(?:m[ae]n|wom[ae]n): pilot(s) - anchor(?:m[ae]n|wom[ae]n): anchor(s) - authoress: author - camera(?:m[ae]n|wom[ae]n): camera operator(s) - chair(?:m[ae]n|wom[ae]n): chair(s) - congress(?:m[ae]n|wom[ae]n): member(s) of congress - door(?:m[ae]|wom[ae]n): concierge(s) - draft(?:m[ae]n|wom[ae]n): drafter(s) - fire(?:m[ae]n|wom[ae]n): firefighter(s) - fisher(?:m[ae]n|wom[ae]n): fisher(s) - fresh(?:m[ae]n|wom[ae]n): first-year student(s) - garbage(?:m[ae]n|wom[ae]n): waste collector(s) - lady lawyer: lawyer - ladylike: courteous - landlord: building manager - mail(?:m[ae]n|wom[ae]n): mail carriers - man and wife: husband and wife - man enough: strong enough - mankind: human kind - manmade: manufactured - manpower: personnel - men and girls: men and women - middle(?:m[ae]n|wom[ae]n): intermediary - news(?:m[ae]n|wom[ae]n): journalist(s) - ombuds(?:man|woman): ombuds - oneupmanship: upstaging - poetess: poet - police(?:m[ae]n|wom[ae]n): police officer(s) - repair(?:m[ae]n|wom[ae]n): technician(s) - sales(?:m[ae]n|wom[ae]n): salesperson or sales people - service(?:m[ae]n|wom[ae]n): soldier(s) - steward(?:ess)?: flight attendant - tribes(?:m[ae]n|wom[ae]n): tribe member(s) - waitress: waiter - woman doctor: doctor - woman scientist[s]?: scientist(s) - work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/reference/.vale-styles/Microsoft/GeneralURL.yml b/reference/.vale-styles/Microsoft/GeneralURL.yml deleted file mode 100644 index dcef503d..00000000 --- a/reference/.vale-styles/Microsoft/GeneralURL.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "For a general audience, use 'address' rather than 'URL'." -link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses -level: warning -action: - name: replace - params: - - URL - - address -tokens: - - URL diff --git a/reference/.vale-styles/Microsoft/HeadingAcronyms.yml b/reference/.vale-styles/Microsoft/HeadingAcronyms.yml deleted file mode 100644 index 6c91e662..00000000 --- a/reference/.vale-styles/Microsoft/HeadingAcronyms.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "Avoid using acronyms in a title or heading." -link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acronyms-in-titles-and-headings -level: warning -scope: heading -tokens: - - '[A-Z]{2,4}' -exceptions: - - SDK - - AD - - SAS - - BOM - - JMS - - API diff --git a/reference/.vale-styles/Microsoft/HeadingColons.yml b/reference/.vale-styles/Microsoft/HeadingColons.yml deleted file mode 100644 index 7013c391..00000000 --- a/reference/.vale-styles/Microsoft/HeadingColons.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Capitalize '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons -nonword: true -level: error -scope: heading -tokens: - - ':\s[a-z]' diff --git a/reference/.vale-styles/Microsoft/HeadingPunctuation.yml b/reference/.vale-styles/Microsoft/HeadingPunctuation.yml deleted file mode 100644 index af04b02e..00000000 --- a/reference/.vale-styles/Microsoft/HeadingPunctuation.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't use end punctuation in headings." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -nonword: true -level: warning -scope: heading -action: - name: edit - params: - - remove - - '.?!' -tokens: - - '[a-z][.?!](?:\s|$)' diff --git a/reference/.vale-styles/Microsoft/Headings.yml b/reference/.vale-styles/Microsoft/Headings.yml deleted file mode 100644 index 63624edc..00000000 --- a/reference/.vale-styles/Microsoft/Headings.yml +++ /dev/null @@ -1,28 +0,0 @@ -extends: capitalization -message: "'%s' should use sentence-style capitalization." -link: https://docs.microsoft.com/en-us/style-guide/capitalization -level: suggestion -scope: heading -match: $sentence -indicators: - - ':' -exceptions: - - Azure - - CLI - - Code - - Cosmos - - Docker - - Emmet - - I - - Kubernetes - - Linux - - macOS - - Marketplace - - MongoDB - - REPL - - Studio - - TypeScript - - URLs - - Visual - - VS - - Windows diff --git a/reference/.vale-styles/Microsoft/Hyphens.yml b/reference/.vale-styles/Microsoft/Hyphens.yml deleted file mode 100644 index 90bbb5de..00000000 --- a/reference/.vale-styles/Microsoft/Hyphens.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "'%s' doesn't need a hyphen." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens -level: warning -ignorecase: false -nonword: true -action: - name: edit - params: - - replace - - '-' - - ' ' -tokens: - - '\s[^\s-]+ly-' diff --git a/reference/.vale-styles/Microsoft/Negative.yml b/reference/.vale-styles/Microsoft/Negative.yml deleted file mode 100644 index d6ff2f22..00000000 --- a/reference/.vale-styles/Microsoft/Negative.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Form a negative number with an en dash, not a hyphen." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '-' - - '–' -tokens: - - '\s-\d+\s' diff --git a/reference/.vale-styles/Microsoft/Ordinal.yml b/reference/.vale-styles/Microsoft/Ordinal.yml deleted file mode 100644 index e3483e38..00000000 --- a/reference/.vale-styles/Microsoft/Ordinal.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't add -ly to an ordinal number." -link: https://docs.microsoft.com/en-us/style-guide/numbers -level: error -action: - name: edit - params: - - trim - - ly -tokens: - - firstly - - secondly - - thirdly diff --git a/reference/.vale-styles/Microsoft/OxfordComma.yml b/reference/.vale-styles/Microsoft/OxfordComma.yml deleted file mode 100644 index 493b55c3..00000000 --- a/reference/.vale-styles/Microsoft/OxfordComma.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Use the Oxford comma in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas -scope: sentence -level: suggestion -nonword: true -tokens: - - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' diff --git a/reference/.vale-styles/Microsoft/Passive.yml b/reference/.vale-styles/Microsoft/Passive.yml deleted file mode 100644 index 102d377c..00000000 --- a/reference/.vale-styles/Microsoft/Passive.yml +++ /dev/null @@ -1,183 +0,0 @@ -extends: existence -message: "'%s' looks like passive voice." -ignorecase: true -level: suggestion -raw: - - \b(am|are|were|being|is|been|was|be)\b\s* -tokens: - - '[\w]+ed' - - awoken - - beat - - become - - been - - begun - - bent - - beset - - bet - - bid - - bidden - - bitten - - bled - - blown - - born - - bought - - bound - - bred - - broadcast - - broken - - brought - - built - - burnt - - burst - - cast - - caught - - chosen - - clung - - come - - cost - - crept - - cut - - dealt - - dived - - done - - drawn - - dreamt - - driven - - drunk - - dug - - eaten - - fallen - - fed - - felt - - fit - - fled - - flown - - flung - - forbidden - - foregone - - forgiven - - forgotten - - forsaken - - fought - - found - - frozen - - given - - gone - - gotten - - ground - - grown - - heard - - held - - hidden - - hit - - hung - - hurt - - kept - - knelt - - knit - - known - - laid - - lain - - leapt - - learnt - - led - - left - - lent - - let - - lighted - - lost - - made - - meant - - met - - misspelt - - mistaken - - mown - - overcome - - overdone - - overtaken - - overthrown - - paid - - pled - - proven - - put - - quit - - read - - rid - - ridden - - risen - - run - - rung - - said - - sat - - sawn - - seen - - sent - - set - - sewn - - shaken - - shaven - - shed - - shod - - shone - - shorn - - shot - - shown - - shrunk - - shut - - slain - - slept - - slid - - slit - - slung - - smitten - - sold - - sought - - sown - - sped - - spent - - spilt - - spit - - split - - spoken - - spread - - sprung - - spun - - stolen - - stood - - stridden - - striven - - struck - - strung - - stuck - - stung - - stunk - - sung - - sunk - - swept - - swollen - - sworn - - swum - - swung - - taken - - taught - - thought - - thrived - - thrown - - thrust - - told - - torn - - trodden - - understood - - upheld - - upset - - wed - - wept - - withheld - - withstood - - woken - - won - - worn - - wound - - woven - - written - - wrung diff --git a/reference/.vale-styles/Microsoft/Percentages.yml b/reference/.vale-styles/Microsoft/Percentages.yml deleted file mode 100644 index b68a7363..00000000 --- a/reference/.vale-styles/Microsoft/Percentages.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use a numeral plus the units." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -tokens: - - '\b[a-zA-z]+\spercent\b' diff --git a/reference/.vale-styles/Microsoft/Quotes.yml b/reference/.vale-styles/Microsoft/Quotes.yml deleted file mode 100644 index 38f49760..00000000 --- a/reference/.vale-styles/Microsoft/Quotes.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: 'Punctuation should be inside the quotes.' -link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks -level: error -nonword: true -tokens: - - '["“][^"”“]+["”][.,]' diff --git a/reference/.vale-styles/Microsoft/RangeFormat.yml b/reference/.vale-styles/Microsoft/RangeFormat.yml deleted file mode 100644 index f1d736e9..00000000 --- a/reference/.vale-styles/Microsoft/RangeFormat.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Use an en dash in a range of numbers." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '-' - - '–' -tokens: - - '\b\d+\s?[-]\s?\d+\b' diff --git a/reference/.vale-styles/Microsoft/RangeTime.yml b/reference/.vale-styles/Microsoft/RangeTime.yml deleted file mode 100644 index cdd4b334..00000000 --- a/reference/.vale-styles/Microsoft/RangeTime.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Use 'to' instead of a dash in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '[-–]' - - 'to' -tokens: - - '\b(?:AM|PM)\s?[-–]\s?.+(?:AM|PM)\b' diff --git a/reference/.vale-styles/Microsoft/Ranges.yml b/reference/.vale-styles/Microsoft/Ranges.yml deleted file mode 100644 index 67d9702b..00000000 --- a/reference/.vale-styles/Microsoft/Ranges.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "In most cases, use 'from' or 'through' to describe a range of numbers." -link: 'https://docs.microsoft.com/en-us/style-guide/numbers' -nonword: true -level: warning -tokens: - - '\b\d+\s?[-–]\s?\d+\b' diff --git a/reference/.vale-styles/Microsoft/Semicolon.yml b/reference/.vale-styles/Microsoft/Semicolon.yml deleted file mode 100644 index 4d905467..00000000 --- a/reference/.vale-styles/Microsoft/Semicolon.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Try to simplify this sentence." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/semicolons -nonword: true -scope: sentence -level: suggestion -tokens: - - ';' diff --git a/reference/.vale-styles/Microsoft/SentenceLength.yml b/reference/.vale-styles/Microsoft/SentenceLength.yml deleted file mode 100644 index f248cf05..00000000 --- a/reference/.vale-styles/Microsoft/SentenceLength.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: occurrence -message: "Try to keep sentences short (< 30 words)." -scope: sentence -level: suggestion -max: 30 -token: \b(\w+)\b - diff --git a/reference/.vale-styles/Microsoft/Spacing.yml b/reference/.vale-styles/Microsoft/Spacing.yml deleted file mode 100644 index 4189306f..00000000 --- a/reference/.vale-styles/Microsoft/Spacing.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: existence -message: "'%s' should have one space." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -level: error -nonword: true -tokens: - - '[a-z][.?!] {2,}[A-Z]' - - '[a-z][.?!][A-Z]' -exceptions: - - \ No newline at end of file diff --git a/reference/.vale-styles/Microsoft/Suspended.yml b/reference/.vale-styles/Microsoft/Suspended.yml deleted file mode 100644 index 7282e9c9..00000000 --- a/reference/.vale-styles/Microsoft/Suspended.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't use '%s' unless space is limited." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens -ignorecase: true -level: warning -tokens: - - '\w+- and \w+-' diff --git a/reference/.vale-styles/Microsoft/Terms.yml b/reference/.vale-styles/Microsoft/Terms.yml deleted file mode 100644 index e41ff74b..00000000 --- a/reference/.vale-styles/Microsoft/Terms.yml +++ /dev/null @@ -1,43 +0,0 @@ -extends: substitution -message: "Prefer '%s' over '%s'." -level: warning -ignorecase: true -action: - name: replace -swap: - '(?:agent|virtual assistant|intelligent personal assistant)': personal digital assistant - '(?:drive C:|drive C>|C: drive)': drive C - '(?:internet bot|web robot)s?': bot(s) - '(?:microsoft cloud|the cloud)': cloud - '(?:mobile|smart) ?phone': phone - '24/7': every day - 'audio(?:-| )book': audiobook - 'back(?:-| )light': backlight - 'chat ?bots?': chatbot(s) - adaptor: adapter - administrate: administer - afterwards: afterward - alphabetic: alphabetical - alphanumerical: alphanumeric - anti-aliasing: antialiasing - anti-malware: antimalware - anti-spyware: antispyware - anti-virus: antivirus - appendixes: appendices - artificial intelligence: artificial intelligence - assembler: assembly language - bpp: bpp - bps: bps - caap: CaaP - conversation-as-a-platform: conversation as a platform - eb: EB - gb: GB - gbps: Gbps - kb: KB - keypress: keystroke - mb: MB - pb: PB - tb: TB - zb: ZB - viz: namely - ergo: therefore diff --git a/reference/.vale-styles/Microsoft/URLFormat.yml b/reference/.vale-styles/Microsoft/URLFormat.yml deleted file mode 100644 index 82e702f9..00000000 --- a/reference/.vale-styles/Microsoft/URLFormat.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -ignorecase: true -level: error -action: - name: replace -swap: - URL for: URL of - an URL: a URL - diff --git a/reference/.vale-styles/Microsoft/Units.yml b/reference/.vale-styles/Microsoft/Units.yml deleted file mode 100644 index f062418e..00000000 --- a/reference/.vale-styles/Microsoft/Units.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: existence -message: "Don't spell out the number in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/units-of-measure-terms -level: error -raw: - - '[a-zA-Z]+\s' -tokens: - - '(?:centi|milli)?meters' - - '(?:kilo)?grams' - - '(?:kilo)?meters' - - '(?:mega)?pixels' - - cm - - inches - - lb - - miles - - pounds diff --git a/reference/.vale-styles/Microsoft/Vocab.yml b/reference/.vale-styles/Microsoft/Vocab.yml deleted file mode 100644 index eebe97b1..00000000 --- a/reference/.vale-styles/Microsoft/Vocab.yml +++ /dev/null @@ -1,25 +0,0 @@ -extends: existence -message: "Verify your use of '%s' with the A-Z word list." -link: 'https://docs.microsoft.com/en-us/style-guide' -level: suggestion -ignorecase: true -tokens: - - above - - accessible - - actionable - - against - - alarm - - alert - - alias - - allows? - - and/or - - as well as - - assure - - author - - avg - - beta - - ensure - - he - - insure - - sample - - she diff --git a/reference/.vale-styles/Microsoft/We.yml b/reference/.vale-styles/Microsoft/We.yml deleted file mode 100644 index 97c901c1..00000000 --- a/reference/.vale-styles/Microsoft/We.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Try to avoid using first-person plural like '%s'." -link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural -level: warning -ignorecase: true -tokens: - - we - - we'(?:ve|re) - - ours? - - us - - let's diff --git a/reference/.vale-styles/Microsoft/Wordiness.yml b/reference/.vale-styles/Microsoft/Wordiness.yml deleted file mode 100644 index 22a4c932..00000000 --- a/reference/.vale-styles/Microsoft/Wordiness.yml +++ /dev/null @@ -1,122 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: warning -action: - name: replace -swap: - (?:give|gave) rise to: lead to - (?:previous|prior) to: before - a (?:large)? majority of: most - a (?:large)? number of: many - a myriad of: myriad - adversely impact: hurt - all across: across - all of a sudden: suddenly - all of these: these - all of: all - all-time record: record - almost all: most - almost never: seldom - along the lines of: similar to - an adequate number of: enough - an appreciable number of: many - an estimated: about - any and all: all - are in agreement: agree - as a matter of fact: in fact - as a means of: to - as a result of: because of - as of yet: yet - as per: per - at a later date: later - at all times: always - at the present time: now - at this point in time: at this point - based in large part on: based on - based on the fact that: because - basic necessity: necessity - because of the fact that: because - came to a realization: realized - came to an abrupt end: ended abruptly - carry out an evaluation of: evaluate - close down: close - closed down: closed - complete stranger: stranger - completely separate: separate - concerning the matter of: regarding - conduct a review of: review - conduct an investigation: investigate - conduct experiments: experiment - continue on: continue - despite the fact that: although - disappear from sight: disappear - drag and drop: drag - drag-and-drop: drag - doomed to fail: doomed - due to the fact that: because - during the period of: during - during the time that: while - emergency situation: emergency - except when: unless - excessive number: too many - extend an invitation: invite - fall down: fall - fell down: fell - for the duration of: during - gather together: gather - has the ability to: can - has the capacity to: can - has the opportunity to: could - hold a meeting: meet - if this is not the case: if not - in a careful manner: carefully - in a thoughtful manner: thoughtfully - in a timely manner: timely - in an effort to: to - in between: between - in lieu of: instead of - in many cases: often - in most cases: usually - in order to: to - in some cases: sometimes - in spite of the fact that: although - in spite of: despite - in the (?:very)? near future: soon - in the event that: if - in the neighborhood of: roughly - in the vicinity of: close to - it would appear that: apparently - lift up: lift - made reference to: referred to - make reference to: refer to - mix together: mix - none at all: none - not in a position to: unable - not possible: impossible - of major importance: important - perform an assessment of: assess - pertaining to: about - place an order: order - plays a key role in: is essential to - present time: now - readily apparent: apparent - some of the: some - span across: span - subsequent to: after - successfully complete: complete - sufficient number (?:of)?: enough - take action: act - take into account: consider - the question as to whether: whether - there is no doubt but that: doubtless - this day and age: this age - this is a subject that: this subject - time (?:frame|period): time - under the provisions of: under - until such time as: until - used for fuel purposes: used for fuel - whether or not: whether - with regard to: regarding - with the exception of: except for diff --git a/reference/.vale-styles/Microsoft/meta.json b/reference/.vale-styles/Microsoft/meta.json deleted file mode 100644 index 297719bb..00000000 --- a/reference/.vale-styles/Microsoft/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/errata-ai/Microsoft/releases.atom", - "vale_version": ">=1.0.0" -} diff --git a/reference/.vale.ini b/reference/.vale.ini deleted file mode 100644 index 6574c688..00000000 --- a/reference/.vale.ini +++ /dev/null @@ -1,20 +0,0 @@ -# Core properties -#---------------- -# Specify where to find styles -StylesPath = .vale-styles - -# Specify the minimum alert level to report -# Alerts are assigned a level of suggestion, warning, or error. -# For local use it's good to see all the suggestions and warnings. -MinAlertLevel = suggestion - -# Specify how to test a particular type of files -#----------------------------------------------- -[*.{adoc,md}] - -# Vale comes with three built-in styles: write-good, proselint, and Joblint. -# You could enable all rules in the "Microsoft" style guide as follows: -# BasedOnStyles = Microsoft -BasedOnStyles = Microsoft - -Microsoft.Headings = NO diff --git a/reference/README.adoc b/reference/README.adoc deleted file mode 100644 index a83ae683..00000000 --- a/reference/README.adoc +++ /dev/null @@ -1 +0,0 @@ -This project is used to manage docs displayed in the https://microsoft.github.io/spring-cloud-azure[GitHub Pages] \ No newline at end of file diff --git a/reference/pom.xml b/reference/pom.xml deleted file mode 100644 index 14ba3ee1..00000000 --- a/reference/pom.xml +++ /dev/null @@ -1,253 +0,0 @@ - - - 4.0.0 - - - com.azure.spring - spring-cloud-azure-docs - 4.1.0-beta.1 - ../pom.xml - - - spring-cloud-azure-docs-reference - spring-cloud-azure-docs-reference - - - ${project.build.directory}/generated-docs/${project.version}/reference/html - - - - - - com.azure.spring - spring-cloud-azure-dependencies - 4.0.0 - pom - import - - - - - - - com.azure.spring - spring-cloud-azure-starter - - - com.azure.spring - spring-cloud-azure-starter-stream-eventhubs - - - com.azure.spring - spring-cloud-azure-starter-stream-servicebus - - - - - - - org.codehaus.mojo - exec-maven-plugin - 3.0.0 - - - org.springframework.cloud - spring-cloud-build-docs - 3.1.1 - jar - - - - true - org.springframework.cloud.internal.Main - - - - generate-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops.adoc - spring.jms.servicebus.*|spring.cloud.azure.* - - - - - generate-global-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_global.adoc - spring.cloud.azure.(client|credential|profile|proxy|retry).* - - - - - generate-aad-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_aad.adoc - spring.cloud.azure.active-directory.* - - - - - generate-aadb2c-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_aadb2c.adoc - spring.cloud.azure.active-directory.b2c.* - - - - - generate-appconf-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_appconf.adoc - spring.cloud.azure.appconfiguration.* - - - - - generate-cosmos-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_cosmos.adoc - spring.cloud.azure.cosmos.* - - - - - generate-eventhubs-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_eventhubs.adoc - spring.cloud.azure.eventhubs.* - - - - - generate-kv-secret-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_kv_secret.adoc - spring.cloud.azure.keyvault.secret.* - - - - - generate-kv-certificate-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_kv_certificate.adoc - spring.cloud.azure.keyvault.certificate.* - - - - - generate-servicebus-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_servicebus.adoc - spring.cloud.azure.servicebus.* - - - - - generate-servicebus-jms-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_servicebus_jms.adoc - spring.jms.servicebus.* - - - - - generate-storage-blob-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_storage_blob.adoc - spring.cloud.azure.storage.blob.* - - - - - generate-storage-fileshare-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_storage_fileshare.adoc - spring.cloud.azure.storage.fileshare.* - - - - - generate-storage-queue-configprops - generate-sources - - java - - - - ${project.basedir}/src/main/asciidoc/_configprops_storage_queue.adoc - spring.cloud.azure.storage.queue.* - - - - - - - - - diff --git a/reference/src/main/.gitignore b/reference/src/main/.gitignore deleted file mode 100644 index acf32da4..00000000 --- a/reference/src/main/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -META-INF/ -org/ \ No newline at end of file diff --git a/reference/src/main/asciidoc/_attributes.adoc b/reference/src/main/asciidoc/_attributes.adoc deleted file mode 100644 index 201f33bb..00000000 --- a/reference/src/main/asciidoc/_attributes.adoc +++ /dev/null @@ -1,16 +0,0 @@ -:doctype: book -:idprefix: -:idseparator: - -:toc: left -:toclevels: 4 -:tabsize: 4 -:numbered: -:sectanchors: -:sectnums: -:icons: font -:hide-uri-scheme: -:docinfo: shared,private - -:sc-ext: java -:project-full-name: Spring Cloud Azure -:all: {asterisk}{asterisk} diff --git a/reference/src/main/asciidoc/appendix.adoc b/reference/src/main/asciidoc/appendix.adoc deleted file mode 100644 index 00d3f9d6..00000000 --- a/reference/src/main/asciidoc/appendix.adoc +++ /dev/null @@ -1,66 +0,0 @@ - -[appendix] -== Configuration Properties - -=== Global Properties - -include::_configprops_global.adoc[] - -=== Azure Active Directory Properties - -include::_configprops_aad.adoc[] - -=== Azure Active Directory B2C Properties - -include::_configprops_aadb2c.adoc[] - -=== Azure App Configuration Properties - -include::_configprops_appconf.adoc[] - -=== Azure Cosmos Properties - -include::_configprops_cosmos.adoc[] - -=== Azure Event Hubs Properties - -include::_configprops_eventhubs.adoc[] - -=== Azure Key Vault Secrets Properties - -include::_configprops_kv_secret.adoc[] - -=== Azure Key Vault Certificates Properties - -include::_configprops_kv_certificate.adoc[] - -=== Azure Service Bus Properties - -include::_configprops_servicebus.adoc[] - -=== Azure Service Bus JMS Properties - -include::_configprops_servicebus_jms.adoc[] - -=== Azure Storage Blob Properties - -include::_configprops_storage_blob.adoc[] - -=== Azure Storage File Share Properties - -include::_configprops_storage_fileshare.adoc[] - -=== Azure Storage Queue Properties - -include::_configprops_storage_queue.adoc[] - -=== All Configuration Properties - -include::_configprops.adoc[] - -[appendix] -include::_migration-guide-for-4.0.adoc[] - -[appendix] -include::_known-issues.adoc[] - diff --git a/reference/src/main/asciidoc/docinfo.html b/reference/src/main/asciidoc/docinfo.html deleted file mode 100644 index 1b364b3c..00000000 --- a/reference/src/main/asciidoc/docinfo.html +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/reference/src/main/asciidoc/index.adoc b/reference/src/main/asciidoc/index.adoc deleted file mode 100644 index b954d922..00000000 --- a/reference/src/main/asciidoc/index.adoc +++ /dev/null @@ -1,41 +0,0 @@ - -include::_attributes.adoc[] - -= Reference - -include::version-information.adoc[] -include::legal.adoc[] -include::intro.adoc[] - -include::getting-help.adoc[] -include::whats-new-4.0.adoc[] -include::migration-guide-for-4.0.adoc[] -include::getting-started.adoc[] -include::configuration.adoc[] -include::authentication.adoc[] -include::production-ready.adoc[] -include::auto-configure-azure-sdk-clients.adoc[] -include::resource-handling.adoc[] -include::secret-management.adoc[] -include::spring-data-support.adoc[] -include::spring-security-support.adoc[] -include::spring-integration-support.adoc[] -include::spring-cloud-stream-support.adoc[] -include::spring-jms-support.adoc[] -include::kafka-support.adoc[] -include::redis-support.adoc[] -include::resource-manager.adoc[] -include::configuration-properties.adoc[] - -== Appendix - -=== link:appendix.html##configuration-properties[Configuration properties] -=== link:appendix.html#migration-guide-for-4-0[Migration guide for 4.0] -=== link:appendix.html#known-issues[Known issues] - - -== link:https://projects.spring.io/spring-boot/[Spring Boot] - -== link:https://spring.io/projects[Spring Project References] - -== link:https://github.com/Microsoft/azure-spring-boot/[Spring Boot Starters for Azure] diff --git a/samples/.vale-styles/Microsoft/AMPM.yml b/samples/.vale-styles/Microsoft/AMPM.yml deleted file mode 100644 index 8b9fed16..00000000 --- a/samples/.vale-styles/Microsoft/AMPM.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: Use 'AM' or 'PM' (preceded by a space). -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms -level: error -nonword: true -tokens: - - '\d{1,2}[AP]M' - - '\d{1,2} ?[ap]m' - - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/samples/.vale-styles/Microsoft/Accessibility.yml b/samples/.vale-styles/Microsoft/Accessibility.yml deleted file mode 100644 index 05bf9273..00000000 --- a/samples/.vale-styles/Microsoft/Accessibility.yml +++ /dev/null @@ -1,25 +0,0 @@ -extends: existence -message: "Don't use language (such as '%s') that defines people by their disability." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms -level: suggestion -ignorecase: true -tokens: - - a victim of - - able-bodied - - affected by - - an epileptic - - crippled - - disabled - - dumb - - handicapped - - handicaps - - healthy - - lame - - maimed - - missing a limb - - mute - - normal - - sight-impaired - - stricken with - - suffers from - - vision-impaired diff --git a/samples/.vale-styles/Microsoft/Acronyms.yml b/samples/.vale-styles/Microsoft/Acronyms.yml deleted file mode 100644 index 82f240ab..00000000 --- a/samples/.vale-styles/Microsoft/Acronyms.yml +++ /dev/null @@ -1,73 +0,0 @@ -extends: conditional -message: "'%s' has no definition." -link: https://docs.microsoft.com/en-us/style-guide/acronyms -level: suggestion -ignorecase: false -# Ensures that the existence of 'first' implies the existence of 'second'. -first: '\b([A-Z]{3,5})\b' -second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' -# ... with the exception of these: -exceptions: - - API - - ASP - - CLI - - CPU - - CSS - - CSV - - DEBUG - - DOM - - DPI - - FAQ - - GCC - - GDB - - GET - - GPU - - GTK - - GUI - - HTML - - HTTP - - HTTPS - - IDE - - JAR - - JSON - - JSX - - LESS - - LLDB - - NET - - NOTE - - NVDA - - OSS - - PATH - - PDF - - PHP - - POST - - RAM - - REPL - - RSA - - SCM - - SCSS - - SDK - - SQL - - SSH - - SSL - - SVG - - TBD - - TCP - - TODO - - URI - - URL - - USB - - UTF - - XML - - XSS - - YAML - - ZIP - - BOM - - AMQP - - AAD - - POSIX - - AKS - - PEM - - CRUD - - SAS - - JMS diff --git a/samples/.vale-styles/Microsoft/Adverbs.yml b/samples/.vale-styles/Microsoft/Adverbs.yml deleted file mode 100644 index 07d98d83..00000000 --- a/samples/.vale-styles/Microsoft/Adverbs.yml +++ /dev/null @@ -1,270 +0,0 @@ -extends: existence -message: "Consider removing '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: warning -action: - name: remove -tokens: - - abnormally - - absentmindedly - - accidentally - - adventurously - - anxiously - - arrogantly - - awkwardly - - bashfully - - beautifully - - bitterly - - bleakly - - blindly - - blissfully - - boastfully - - boldly - - bravely - - briefly - - brightly - - briskly - - broadly - - busily - - calmly - - carefully - - carelessly - - cautiously - - cheerfully - - cleverly - - closely - - coaxingly - - colorfully - - continually - - coolly - - courageously - - crossly - - cruelly - - curiously - - daintily - - dearly - - deceivingly - - deeply - - defiantly - - deliberately - - delightfully - - diligently - - dimly - - doubtfully - - dreamily - - easily - - elegantly - - energetically - - enormously - - enthusiastically - - excitedly - - extremely - - fairly - - faithfully - - famously - - ferociously - - fervently - - fiercely - - fondly - - foolishly - - fortunately - - frankly - - frantically - - freely - - frenetically - - frightfully - - furiously - - generally - - generously - - gently - - gladly - - gleefully - - gracefully - - gratefully - - greatly - - greedily - - happily - - hastily - - healthily - - heavily - - helplessly - - honestly - - hopelessly - - hungrily - - innocently - - inquisitively - - intensely - - intently - - interestingly - - inwardly - - irritably - - jaggedly - - jealously - - jovially - - joyfully - - joyously - - jubilantly - - judgmentally - - justly - - keenly - - kiddingly - - kindheartedly - - knavishly - - knowingly - - knowledgeably - - lazily - - lightly - - limply - - lively - - loftily - - longingly - - loosely - - loudly - - lovingly - - loyally - - madly - - majestically - - meaningfully - - mechanically - - merrily - - miserably - - mockingly - - mortally - - mysteriously - - naturally - - nearly - - neatly - - nervously - - nicely - - noisily - - obediently - - obnoxiously - - oddly - - offensively - - optimistically - - overconfidently - - painfully - - partially - - patiently - - perfectly - - playfully - - politely - - poorly - - positively - - potentially - - powerfully - - promptly - - properly - - punctually - - quaintly - - queasily - - queerly - - questionably - - quickly - - quietly - - quirkily - - quizzically - - randomly - - rapidly - - rarely - - readily - - really - - reassuringly - - recklessly - - regularly - - reluctantly - - repeatedly - - reproachfully - - restfully - - righteously - - rightfully - - rigidly - - roughly - - rudely - - safely - - scarcely - - scarily - - searchingly - - sedately - - seemingly - - selfishly - - separately - - seriously - - shakily - - sharply - - sheepishly - - shrilly - - shyly - - silently - - sleepily - - slowly - - smoothly - - softly - - solemnly - - solidly - - speedily - - stealthily - - sternly - - strictly - - suddenly - - supposedly - - surprisingly - - suspiciously - - sweetly - - swiftly - - sympathetically - - tenderly - - tensely - - terribly - - thankfully - - thoroughly - - thoughtfully - - tightly - - tremendously - - triumphantly - - truthfully - - ultimately - - unabashedly - - unaccountably - - unbearably - - unethically - - unexpectedly - - unfortunately - - unimpressively - - unnaturally - - unnecessarily - - urgently - - usefully - - uselessly - - utterly - - vacantly - - vaguely - - vainly - - valiantly - - vastly - - verbally - - very - - viciously - - victoriously - - violently - - vivaciously - - voluntarily - - warmly - - weakly - - wearily - - wetly - - wholly - - wildly - - willfully - - wisely - - woefully - - wonderfully - - worriedly - - yawningly - - yearningly - - yieldingly - - youthfully - - zealously - - zestfully - - zestily diff --git a/samples/.vale-styles/Microsoft/Auto.yml b/samples/.vale-styles/Microsoft/Auto.yml deleted file mode 100644 index 4da43935..00000000 --- a/samples/.vale-styles/Microsoft/Auto.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "In general, don't hyphenate '%s'." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto -ignorecase: true -level: error -action: - name: convert - params: - - simple -tokens: - - 'auto-\w+' diff --git a/samples/.vale-styles/Microsoft/Avoid.yml b/samples/.vale-styles/Microsoft/Avoid.yml deleted file mode 100644 index dab7822c..00000000 --- a/samples/.vale-styles/Microsoft/Avoid.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "Don't use '%s'. See the A-Z word list for details." -# See the A-Z word list -link: https://docs.microsoft.com/en-us/style-guide -ignorecase: true -level: error -tokens: - - abortion - - and so on - - app(?:lication)?s? (?:developer|program) - - app(?:lication)? file - - backbone - - backend - - contiguous selection diff --git a/samples/.vale-styles/Microsoft/ComplexWords.yml b/samples/.vale-styles/Microsoft/ComplexWords.yml deleted file mode 100644 index 65b7a347..00000000 --- a/samples/.vale-styles/Microsoft/ComplexWords.yml +++ /dev/null @@ -1,120 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: suggestion -action: - name: replace -swap: - "approximate(?:ly)?": about - abundance: plenty - accelerate: speed up - accentuate: stress - accompany: go with - accomplish: carry out|do - accorded: given - accordingly: so - accrue: add - accurate: right|exact - acquiesce: agree - acquire: get|buy - additional: more|extra - address: discuss - addressees: you - adjacent to: next to - adjustment: change - admissible: allowed - advantageous: helpful - advise: tell - aggregate: total - aircraft: plane - alleviate: ease - allocate: assign|divide - alternatively: or - alternatives: choices|options - ameliorate: improve - amend: change - anticipate: expect - apparent: clear|plain - ascertain: discover|find out - assistance: help - attain: meet - attempt: try - authorize: allow - belated: late - bestow: give - cease: stop|end - collaborate: work together - commence: begin - compensate: pay - component: part - comprise: form|include - concept: idea - concerning: about - confer: give|award - consequently: so - consolidate: merge - constitutes: forms - contains: has - convene: meet - demonstrate: show|prove - depart: leave - designate: choose - desire: want|wish - determine: decide|find - detrimental: bad|harmful - disclose: share|tell - discontinue: stop - disseminate: send|give - eliminate: end - elucidate: explain - employ: use - enclosed: inside|included - encounter: meet - endeavor: try - enumerate: count - equitable: fair - equivalent: equal - exclusively: only - expedite: hurry - facilitate: ease - females: women - finalize: complete|finish - frequently: often - identical: same - incorrect: wrong - indication: sign - initiate: start|begin - itemized: listed - jeopardize: risk - liaise: work with|partner with - maintain: keep|support - methodology: method - modify: change - monitor: check|watch - multiple: many - necessitate: cause - notify: tell - numerous: many - objective: aim|goal - obligate: bind|compel - optimum: best|most - permit: let - portion: part - possess: own - previous: earlier - previously: before - prioritize: rank - procure: buy - provide: give|offer - purchase: buy - relocate: move - solicit: request - state-of-the-art: latest - subsequent: later|next - substantial: large - sufficient: enough - terminate: end - transmit: send - utilization: use - utilize: use diff --git a/samples/.vale-styles/Microsoft/Contractions.yml b/samples/.vale-styles/Microsoft/Contractions.yml deleted file mode 100644 index ded330f7..00000000 --- a/samples/.vale-styles/Microsoft/Contractions.yml +++ /dev/null @@ -1,50 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions -level: error -ignorecase: true -action: - name: replace -swap: - are not: aren't - cannot: can't - could not: couldn't - did not: didn't - do not: don't - does not: doesn't - has not: hasn't - have not: haven't - how is: how's - is not: isn't - - 'it is(?!\.)': it's - 'it''s(?=\.)': it is - - should not: shouldn't - - 'that is(?!\.)': that's - 'that''s(?=\.)': that is - - 'they are(?!\.)': they're - 'they''re(?=\.)': they are - - was not: wasn't - - 'we are(?!\.)': we're - 'we''re(?=\.)': we are - - 'we have(?!\.)': we've - 'we''ve(?=\.)': we have - - were not: weren't - - 'what is(?!\.)': what's - 'what''s(?=\.)': what is - - 'when is(?!\.)': when's - 'when''s(?=\.)': when is - - 'where is(?!\.)': where's - 'where''s(?=\.)': where is - - will not: won't diff --git a/samples/.vale-styles/Microsoft/Dashes.yml b/samples/.vale-styles/Microsoft/Dashes.yml deleted file mode 100644 index 2894cf72..00000000 --- a/samples/.vale-styles/Microsoft/Dashes.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Remove the spaces around '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes -ignorecase: true -nonword: true -level: error -action: - name: edit - params: - - remove - - ' ' -tokens: - - '[—–]\s|\s[—–]' diff --git a/samples/.vale-styles/Microsoft/DateFormat.yml b/samples/.vale-styles/Microsoft/DateFormat.yml deleted file mode 100644 index 19653139..00000000 --- a/samples/.vale-styles/Microsoft/DateFormat.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: Use 'July 31, 2016' format, not '%s'. -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms -ignorecase: true -level: error -nonword: true -tokens: - - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/samples/.vale-styles/Microsoft/DateNumbers.yml b/samples/.vale-styles/Microsoft/DateNumbers.yml deleted file mode 100644 index 14d46747..00000000 --- a/samples/.vale-styles/Microsoft/DateNumbers.yml +++ /dev/null @@ -1,40 +0,0 @@ -extends: existence -message: "Don't use ordinal numbers for dates." -link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates -level: error -nonword: true -ignorecase: true -raw: - - \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s* -tokens: - - first - - second - - third - - fourth - - fifth - - sixth - - seventh - - eighth - - ninth - - tenth - - eleventh - - twelfth - - thirteenth - - fourteenth - - fifteenth - - sixteenth - - seventeenth - - eighteenth - - nineteenth - - twentieth - - twenty-first - - twenty-second - - twenty-third - - twenty-fourth - - twenty-fifth - - twenty-sixth - - twenty-seventh - - twenty-eighth - - twenty-ninth - - thirtieth - - thirty-first diff --git a/samples/.vale-styles/Microsoft/DateOrder.yml b/samples/.vale-styles/Microsoft/DateOrder.yml deleted file mode 100644 index 12d69ba5..00000000 --- a/samples/.vale-styles/Microsoft/DateOrder.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Always spell out the name of the month." -link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates -ignorecase: true -level: error -nonword: true -tokens: - - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b' diff --git a/samples/.vale-styles/Microsoft/Ellipses.yml b/samples/.vale-styles/Microsoft/Ellipses.yml deleted file mode 100644 index 320457a8..00000000 --- a/samples/.vale-styles/Microsoft/Ellipses.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "In general, don't use an ellipsis." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses -nonword: true -level: warning -action: - name: remove -tokens: - - '\.\.\.' diff --git a/samples/.vale-styles/Microsoft/FirstPerson.yml b/samples/.vale-styles/Microsoft/FirstPerson.yml deleted file mode 100644 index 77761af8..00000000 --- a/samples/.vale-styles/Microsoft/FirstPerson.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: existence -message: "Use first person (such as '%s') sparingly." -link: https://docs.microsoft.com/en-us/style-guide/grammar/person -ignorecase: true -level: warning -nonword: true -tokens: - - (?:^|\s)I\s - - (?:^|\s)I,\s - - \bI'd\b - - \bI'll\b - - \bI'm\b - - \bI've\b - - \bme\b - - \bmy\b - - \bmine\b diff --git a/samples/.vale-styles/Microsoft/Foreign.yml b/samples/.vale-styles/Microsoft/Foreign.yml deleted file mode 100644 index d37835a5..00000000 --- a/samples/.vale-styles/Microsoft/Foreign.yml +++ /dev/null @@ -1,12 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words -ignorecase: true -level: error -nonword: true -action: - name: replace -swap: - '\b(?:eg|e\.g\.)[\s,]': for example - '\b(?:ie|i\.e\.)[\s,]': that is - diff --git a/samples/.vale-styles/Microsoft/Gender.yml b/samples/.vale-styles/Microsoft/Gender.yml deleted file mode 100644 index 47c08024..00000000 --- a/samples/.vale-styles/Microsoft/Gender.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Don't use '%s'." -link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender -level: error -ignorecase: true -tokens: - - he/she - - s/he diff --git a/samples/.vale-styles/Microsoft/GenderBias.yml b/samples/.vale-styles/Microsoft/GenderBias.yml deleted file mode 100644 index 3d873aa3..00000000 --- a/samples/.vale-styles/Microsoft/GenderBias.yml +++ /dev/null @@ -1,44 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -ignorecase: true -level: error -swap: - (?:alumna|alumnus): graduate - (?:alumnae|alumni): graduates - air(?:m[ae]n|wom[ae]n): pilot(s) - anchor(?:m[ae]n|wom[ae]n): anchor(s) - authoress: author - camera(?:m[ae]n|wom[ae]n): camera operator(s) - chair(?:m[ae]n|wom[ae]n): chair(s) - congress(?:m[ae]n|wom[ae]n): member(s) of congress - door(?:m[ae]|wom[ae]n): concierge(s) - draft(?:m[ae]n|wom[ae]n): drafter(s) - fire(?:m[ae]n|wom[ae]n): firefighter(s) - fisher(?:m[ae]n|wom[ae]n): fisher(s) - fresh(?:m[ae]n|wom[ae]n): first-year student(s) - garbage(?:m[ae]n|wom[ae]n): waste collector(s) - lady lawyer: lawyer - ladylike: courteous - landlord: building manager - mail(?:m[ae]n|wom[ae]n): mail carriers - man and wife: husband and wife - man enough: strong enough - mankind: human kind - manmade: manufactured - manpower: personnel - men and girls: men and women - middle(?:m[ae]n|wom[ae]n): intermediary - news(?:m[ae]n|wom[ae]n): journalist(s) - ombuds(?:man|woman): ombuds - oneupmanship: upstaging - poetess: poet - police(?:m[ae]n|wom[ae]n): police officer(s) - repair(?:m[ae]n|wom[ae]n): technician(s) - sales(?:m[ae]n|wom[ae]n): salesperson or sales people - service(?:m[ae]n|wom[ae]n): soldier(s) - steward(?:ess)?: flight attendant - tribes(?:m[ae]n|wom[ae]n): tribe member(s) - waitress: waiter - woman doctor: doctor - woman scientist[s]?: scientist(s) - work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/samples/.vale-styles/Microsoft/GeneralURL.yml b/samples/.vale-styles/Microsoft/GeneralURL.yml deleted file mode 100644 index dcef503d..00000000 --- a/samples/.vale-styles/Microsoft/GeneralURL.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "For a general audience, use 'address' rather than 'URL'." -link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses -level: warning -action: - name: replace - params: - - URL - - address -tokens: - - URL diff --git a/samples/.vale-styles/Microsoft/HeadingAcronyms.yml b/samples/.vale-styles/Microsoft/HeadingAcronyms.yml deleted file mode 100644 index 6c91e662..00000000 --- a/samples/.vale-styles/Microsoft/HeadingAcronyms.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "Avoid using acronyms in a title or heading." -link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acronyms-in-titles-and-headings -level: warning -scope: heading -tokens: - - '[A-Z]{2,4}' -exceptions: - - SDK - - AD - - SAS - - BOM - - JMS - - API diff --git a/samples/.vale-styles/Microsoft/HeadingColons.yml b/samples/.vale-styles/Microsoft/HeadingColons.yml deleted file mode 100644 index 7013c391..00000000 --- a/samples/.vale-styles/Microsoft/HeadingColons.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Capitalize '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons -nonword: true -level: error -scope: heading -tokens: - - ':\s[a-z]' diff --git a/samples/.vale-styles/Microsoft/HeadingPunctuation.yml b/samples/.vale-styles/Microsoft/HeadingPunctuation.yml deleted file mode 100644 index af04b02e..00000000 --- a/samples/.vale-styles/Microsoft/HeadingPunctuation.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't use end punctuation in headings." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -nonword: true -level: warning -scope: heading -action: - name: edit - params: - - remove - - '.?!' -tokens: - - '[a-z][.?!](?:\s|$)' diff --git a/samples/.vale-styles/Microsoft/Headings.yml b/samples/.vale-styles/Microsoft/Headings.yml deleted file mode 100644 index 63624edc..00000000 --- a/samples/.vale-styles/Microsoft/Headings.yml +++ /dev/null @@ -1,28 +0,0 @@ -extends: capitalization -message: "'%s' should use sentence-style capitalization." -link: https://docs.microsoft.com/en-us/style-guide/capitalization -level: suggestion -scope: heading -match: $sentence -indicators: - - ':' -exceptions: - - Azure - - CLI - - Code - - Cosmos - - Docker - - Emmet - - I - - Kubernetes - - Linux - - macOS - - Marketplace - - MongoDB - - REPL - - Studio - - TypeScript - - URLs - - Visual - - VS - - Windows diff --git a/samples/.vale-styles/Microsoft/Hyphens.yml b/samples/.vale-styles/Microsoft/Hyphens.yml deleted file mode 100644 index 90bbb5de..00000000 --- a/samples/.vale-styles/Microsoft/Hyphens.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "'%s' doesn't need a hyphen." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens -level: warning -ignorecase: false -nonword: true -action: - name: edit - params: - - replace - - '-' - - ' ' -tokens: - - '\s[^\s-]+ly-' diff --git a/samples/.vale-styles/Microsoft/Negative.yml b/samples/.vale-styles/Microsoft/Negative.yml deleted file mode 100644 index d6ff2f22..00000000 --- a/samples/.vale-styles/Microsoft/Negative.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Form a negative number with an en dash, not a hyphen." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '-' - - '–' -tokens: - - '\s-\d+\s' diff --git a/samples/.vale-styles/Microsoft/Ordinal.yml b/samples/.vale-styles/Microsoft/Ordinal.yml deleted file mode 100644 index e3483e38..00000000 --- a/samples/.vale-styles/Microsoft/Ordinal.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't add -ly to an ordinal number." -link: https://docs.microsoft.com/en-us/style-guide/numbers -level: error -action: - name: edit - params: - - trim - - ly -tokens: - - firstly - - secondly - - thirdly diff --git a/samples/.vale-styles/Microsoft/OxfordComma.yml b/samples/.vale-styles/Microsoft/OxfordComma.yml deleted file mode 100644 index 493b55c3..00000000 --- a/samples/.vale-styles/Microsoft/OxfordComma.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Use the Oxford comma in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas -scope: sentence -level: suggestion -nonword: true -tokens: - - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' diff --git a/samples/.vale-styles/Microsoft/Passive.yml b/samples/.vale-styles/Microsoft/Passive.yml deleted file mode 100644 index 102d377c..00000000 --- a/samples/.vale-styles/Microsoft/Passive.yml +++ /dev/null @@ -1,183 +0,0 @@ -extends: existence -message: "'%s' looks like passive voice." -ignorecase: true -level: suggestion -raw: - - \b(am|are|were|being|is|been|was|be)\b\s* -tokens: - - '[\w]+ed' - - awoken - - beat - - become - - been - - begun - - bent - - beset - - bet - - bid - - bidden - - bitten - - bled - - blown - - born - - bought - - bound - - bred - - broadcast - - broken - - brought - - built - - burnt - - burst - - cast - - caught - - chosen - - clung - - come - - cost - - crept - - cut - - dealt - - dived - - done - - drawn - - dreamt - - driven - - drunk - - dug - - eaten - - fallen - - fed - - felt - - fit - - fled - - flown - - flung - - forbidden - - foregone - - forgiven - - forgotten - - forsaken - - fought - - found - - frozen - - given - - gone - - gotten - - ground - - grown - - heard - - held - - hidden - - hit - - hung - - hurt - - kept - - knelt - - knit - - known - - laid - - lain - - leapt - - learnt - - led - - left - - lent - - let - - lighted - - lost - - made - - meant - - met - - misspelt - - mistaken - - mown - - overcome - - overdone - - overtaken - - overthrown - - paid - - pled - - proven - - put - - quit - - read - - rid - - ridden - - risen - - run - - rung - - said - - sat - - sawn - - seen - - sent - - set - - sewn - - shaken - - shaven - - shed - - shod - - shone - - shorn - - shot - - shown - - shrunk - - shut - - slain - - slept - - slid - - slit - - slung - - smitten - - sold - - sought - - sown - - sped - - spent - - spilt - - spit - - split - - spoken - - spread - - sprung - - spun - - stolen - - stood - - stridden - - striven - - struck - - strung - - stuck - - stung - - stunk - - sung - - sunk - - swept - - swollen - - sworn - - swum - - swung - - taken - - taught - - thought - - thrived - - thrown - - thrust - - told - - torn - - trodden - - understood - - upheld - - upset - - wed - - wept - - withheld - - withstood - - woken - - won - - worn - - wound - - woven - - written - - wrung diff --git a/samples/.vale-styles/Microsoft/Percentages.yml b/samples/.vale-styles/Microsoft/Percentages.yml deleted file mode 100644 index b68a7363..00000000 --- a/samples/.vale-styles/Microsoft/Percentages.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use a numeral plus the units." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -tokens: - - '\b[a-zA-z]+\spercent\b' diff --git a/samples/.vale-styles/Microsoft/Quotes.yml b/samples/.vale-styles/Microsoft/Quotes.yml deleted file mode 100644 index 38f49760..00000000 --- a/samples/.vale-styles/Microsoft/Quotes.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: 'Punctuation should be inside the quotes.' -link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks -level: error -nonword: true -tokens: - - '["“][^"”“]+["”][.,]' diff --git a/samples/.vale-styles/Microsoft/RangeFormat.yml b/samples/.vale-styles/Microsoft/RangeFormat.yml deleted file mode 100644 index f1d736e9..00000000 --- a/samples/.vale-styles/Microsoft/RangeFormat.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Use an en dash in a range of numbers." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '-' - - '–' -tokens: - - '\b\d+\s?[-]\s?\d+\b' diff --git a/samples/.vale-styles/Microsoft/RangeTime.yml b/samples/.vale-styles/Microsoft/RangeTime.yml deleted file mode 100644 index cdd4b334..00000000 --- a/samples/.vale-styles/Microsoft/RangeTime.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Use 'to' instead of a dash in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '[-–]' - - 'to' -tokens: - - '\b(?:AM|PM)\s?[-–]\s?.+(?:AM|PM)\b' diff --git a/samples/.vale-styles/Microsoft/Ranges.yml b/samples/.vale-styles/Microsoft/Ranges.yml deleted file mode 100644 index 67d9702b..00000000 --- a/samples/.vale-styles/Microsoft/Ranges.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "In most cases, use 'from' or 'through' to describe a range of numbers." -link: 'https://docs.microsoft.com/en-us/style-guide/numbers' -nonword: true -level: warning -tokens: - - '\b\d+\s?[-–]\s?\d+\b' diff --git a/samples/.vale-styles/Microsoft/Semicolon.yml b/samples/.vale-styles/Microsoft/Semicolon.yml deleted file mode 100644 index 4d905467..00000000 --- a/samples/.vale-styles/Microsoft/Semicolon.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Try to simplify this sentence." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/semicolons -nonword: true -scope: sentence -level: suggestion -tokens: - - ';' diff --git a/samples/.vale-styles/Microsoft/SentenceLength.yml b/samples/.vale-styles/Microsoft/SentenceLength.yml deleted file mode 100644 index f248cf05..00000000 --- a/samples/.vale-styles/Microsoft/SentenceLength.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: occurrence -message: "Try to keep sentences short (< 30 words)." -scope: sentence -level: suggestion -max: 30 -token: \b(\w+)\b - diff --git a/samples/.vale-styles/Microsoft/Spacing.yml b/samples/.vale-styles/Microsoft/Spacing.yml deleted file mode 100644 index 4189306f..00000000 --- a/samples/.vale-styles/Microsoft/Spacing.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: existence -message: "'%s' should have one space." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -level: error -nonword: true -tokens: - - '[a-z][.?!] {2,}[A-Z]' - - '[a-z][.?!][A-Z]' -exceptions: - - \ No newline at end of file diff --git a/samples/.vale-styles/Microsoft/Suspended.yml b/samples/.vale-styles/Microsoft/Suspended.yml deleted file mode 100644 index 7282e9c9..00000000 --- a/samples/.vale-styles/Microsoft/Suspended.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't use '%s' unless space is limited." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens -ignorecase: true -level: warning -tokens: - - '\w+- and \w+-' diff --git a/samples/.vale-styles/Microsoft/Terms.yml b/samples/.vale-styles/Microsoft/Terms.yml deleted file mode 100644 index e41ff74b..00000000 --- a/samples/.vale-styles/Microsoft/Terms.yml +++ /dev/null @@ -1,43 +0,0 @@ -extends: substitution -message: "Prefer '%s' over '%s'." -level: warning -ignorecase: true -action: - name: replace -swap: - '(?:agent|virtual assistant|intelligent personal assistant)': personal digital assistant - '(?:drive C:|drive C>|C: drive)': drive C - '(?:internet bot|web robot)s?': bot(s) - '(?:microsoft cloud|the cloud)': cloud - '(?:mobile|smart) ?phone': phone - '24/7': every day - 'audio(?:-| )book': audiobook - 'back(?:-| )light': backlight - 'chat ?bots?': chatbot(s) - adaptor: adapter - administrate: administer - afterwards: afterward - alphabetic: alphabetical - alphanumerical: alphanumeric - anti-aliasing: antialiasing - anti-malware: antimalware - anti-spyware: antispyware - anti-virus: antivirus - appendixes: appendices - artificial intelligence: artificial intelligence - assembler: assembly language - bpp: bpp - bps: bps - caap: CaaP - conversation-as-a-platform: conversation as a platform - eb: EB - gb: GB - gbps: Gbps - kb: KB - keypress: keystroke - mb: MB - pb: PB - tb: TB - zb: ZB - viz: namely - ergo: therefore diff --git a/samples/.vale-styles/Microsoft/URLFormat.yml b/samples/.vale-styles/Microsoft/URLFormat.yml deleted file mode 100644 index 82e702f9..00000000 --- a/samples/.vale-styles/Microsoft/URLFormat.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -ignorecase: true -level: error -action: - name: replace -swap: - URL for: URL of - an URL: a URL - diff --git a/samples/.vale-styles/Microsoft/Units.yml b/samples/.vale-styles/Microsoft/Units.yml deleted file mode 100644 index f062418e..00000000 --- a/samples/.vale-styles/Microsoft/Units.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: existence -message: "Don't spell out the number in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/units-of-measure-terms -level: error -raw: - - '[a-zA-Z]+\s' -tokens: - - '(?:centi|milli)?meters' - - '(?:kilo)?grams' - - '(?:kilo)?meters' - - '(?:mega)?pixels' - - cm - - inches - - lb - - miles - - pounds diff --git a/samples/.vale-styles/Microsoft/Vocab.yml b/samples/.vale-styles/Microsoft/Vocab.yml deleted file mode 100644 index eebe97b1..00000000 --- a/samples/.vale-styles/Microsoft/Vocab.yml +++ /dev/null @@ -1,25 +0,0 @@ -extends: existence -message: "Verify your use of '%s' with the A-Z word list." -link: 'https://docs.microsoft.com/en-us/style-guide' -level: suggestion -ignorecase: true -tokens: - - above - - accessible - - actionable - - against - - alarm - - alert - - alias - - allows? - - and/or - - as well as - - assure - - author - - avg - - beta - - ensure - - he - - insure - - sample - - she diff --git a/samples/.vale-styles/Microsoft/We.yml b/samples/.vale-styles/Microsoft/We.yml deleted file mode 100644 index 97c901c1..00000000 --- a/samples/.vale-styles/Microsoft/We.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Try to avoid using first-person plural like '%s'." -link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural -level: warning -ignorecase: true -tokens: - - we - - we'(?:ve|re) - - ours? - - us - - let's diff --git a/samples/.vale-styles/Microsoft/Wordiness.yml b/samples/.vale-styles/Microsoft/Wordiness.yml deleted file mode 100644 index 22a4c932..00000000 --- a/samples/.vale-styles/Microsoft/Wordiness.yml +++ /dev/null @@ -1,122 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: warning -action: - name: replace -swap: - (?:give|gave) rise to: lead to - (?:previous|prior) to: before - a (?:large)? majority of: most - a (?:large)? number of: many - a myriad of: myriad - adversely impact: hurt - all across: across - all of a sudden: suddenly - all of these: these - all of: all - all-time record: record - almost all: most - almost never: seldom - along the lines of: similar to - an adequate number of: enough - an appreciable number of: many - an estimated: about - any and all: all - are in agreement: agree - as a matter of fact: in fact - as a means of: to - as a result of: because of - as of yet: yet - as per: per - at a later date: later - at all times: always - at the present time: now - at this point in time: at this point - based in large part on: based on - based on the fact that: because - basic necessity: necessity - because of the fact that: because - came to a realization: realized - came to an abrupt end: ended abruptly - carry out an evaluation of: evaluate - close down: close - closed down: closed - complete stranger: stranger - completely separate: separate - concerning the matter of: regarding - conduct a review of: review - conduct an investigation: investigate - conduct experiments: experiment - continue on: continue - despite the fact that: although - disappear from sight: disappear - drag and drop: drag - drag-and-drop: drag - doomed to fail: doomed - due to the fact that: because - during the period of: during - during the time that: while - emergency situation: emergency - except when: unless - excessive number: too many - extend an invitation: invite - fall down: fall - fell down: fell - for the duration of: during - gather together: gather - has the ability to: can - has the capacity to: can - has the opportunity to: could - hold a meeting: meet - if this is not the case: if not - in a careful manner: carefully - in a thoughtful manner: thoughtfully - in a timely manner: timely - in an effort to: to - in between: between - in lieu of: instead of - in many cases: often - in most cases: usually - in order to: to - in some cases: sometimes - in spite of the fact that: although - in spite of: despite - in the (?:very)? near future: soon - in the event that: if - in the neighborhood of: roughly - in the vicinity of: close to - it would appear that: apparently - lift up: lift - made reference to: referred to - make reference to: refer to - mix together: mix - none at all: none - not in a position to: unable - not possible: impossible - of major importance: important - perform an assessment of: assess - pertaining to: about - place an order: order - plays a key role in: is essential to - present time: now - readily apparent: apparent - some of the: some - span across: span - subsequent to: after - successfully complete: complete - sufficient number (?:of)?: enough - take action: act - take into account: consider - the question as to whether: whether - there is no doubt but that: doubtless - this day and age: this age - this is a subject that: this subject - time (?:frame|period): time - under the provisions of: under - until such time as: until - used for fuel purposes: used for fuel - whether or not: whether - with regard to: regarding - with the exception of: except for diff --git a/samples/.vale-styles/Microsoft/meta.json b/samples/.vale-styles/Microsoft/meta.json deleted file mode 100644 index 297719bb..00000000 --- a/samples/.vale-styles/Microsoft/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/errata-ai/Microsoft/releases.atom", - "vale_version": ">=1.0.0" -} diff --git a/samples/.vale.ini b/samples/.vale.ini deleted file mode 100644 index 6574c688..00000000 --- a/samples/.vale.ini +++ /dev/null @@ -1,20 +0,0 @@ -# Core properties -#---------------- -# Specify where to find styles -StylesPath = .vale-styles - -# Specify the minimum alert level to report -# Alerts are assigned a level of suggestion, warning, or error. -# For local use it's good to see all the suggestions and warnings. -MinAlertLevel = suggestion - -# Specify how to test a particular type of files -#----------------------------------------------- -[*.{adoc,md}] - -# Vale comes with three built-in styles: write-good, proselint, and Joblint. -# You could enable all rules in the "Microsoft" style guide as follows: -# BasedOnStyles = Microsoft -BasedOnStyles = Microsoft - -Microsoft.Headings = NO diff --git a/samples/README.adoc b/samples/README.adoc deleted file mode 100644 index a83ae683..00000000 --- a/samples/README.adoc +++ /dev/null @@ -1 +0,0 @@ -This project is used to manage docs displayed in the https://microsoft.github.io/spring-cloud-azure[GitHub Pages] \ No newline at end of file diff --git a/samples/pom.xml b/samples/pom.xml deleted file mode 100644 index 633c84d5..00000000 --- a/samples/pom.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - 4.0.0 - - - com.azure.spring - spring-cloud-azure-docs - 4.1.0-beta.1 - ../pom.xml - - - spring-cloud-azure-docs-samples - spring-cloud-azure-docs-samples - - - ${project.build.directory}/generated-docs/${project.version}/samples/html - - - diff --git a/samples/src/main/.gitignore b/samples/src/main/.gitignore deleted file mode 100644 index acf32da4..00000000 --- a/samples/src/main/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -META-INF/ -org/ \ No newline at end of file diff --git a/samples/src/main/asciidoc/_attributes.adoc b/samples/src/main/asciidoc/_attributes.adoc deleted file mode 100644 index 201f33bb..00000000 --- a/samples/src/main/asciidoc/_attributes.adoc +++ /dev/null @@ -1,16 +0,0 @@ -:doctype: book -:idprefix: -:idseparator: - -:toc: left -:toclevels: 4 -:tabsize: 4 -:numbered: -:sectanchors: -:sectnums: -:icons: font -:hide-uri-scheme: -:docinfo: shared,private - -:sc-ext: java -:project-full-name: Spring Cloud Azure -:all: {asterisk}{asterisk} diff --git a/samples/src/main/asciidoc/docinfo.html b/samples/src/main/asciidoc/docinfo.html deleted file mode 100644 index 1b364b3c..00000000 --- a/samples/src/main/asciidoc/docinfo.html +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/tutorials/.vale-styles/Microsoft/AMPM.yml b/tutorials/.vale-styles/Microsoft/AMPM.yml deleted file mode 100644 index 8b9fed16..00000000 --- a/tutorials/.vale-styles/Microsoft/AMPM.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: Use 'AM' or 'PM' (preceded by a space). -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms -level: error -nonword: true -tokens: - - '\d{1,2}[AP]M' - - '\d{1,2} ?[ap]m' - - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/tutorials/.vale-styles/Microsoft/Accessibility.yml b/tutorials/.vale-styles/Microsoft/Accessibility.yml deleted file mode 100644 index 05bf9273..00000000 --- a/tutorials/.vale-styles/Microsoft/Accessibility.yml +++ /dev/null @@ -1,25 +0,0 @@ -extends: existence -message: "Don't use language (such as '%s') that defines people by their disability." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms -level: suggestion -ignorecase: true -tokens: - - a victim of - - able-bodied - - affected by - - an epileptic - - crippled - - disabled - - dumb - - handicapped - - handicaps - - healthy - - lame - - maimed - - missing a limb - - mute - - normal - - sight-impaired - - stricken with - - suffers from - - vision-impaired diff --git a/tutorials/.vale-styles/Microsoft/Acronyms.yml b/tutorials/.vale-styles/Microsoft/Acronyms.yml deleted file mode 100644 index 82f240ab..00000000 --- a/tutorials/.vale-styles/Microsoft/Acronyms.yml +++ /dev/null @@ -1,73 +0,0 @@ -extends: conditional -message: "'%s' has no definition." -link: https://docs.microsoft.com/en-us/style-guide/acronyms -level: suggestion -ignorecase: false -# Ensures that the existence of 'first' implies the existence of 'second'. -first: '\b([A-Z]{3,5})\b' -second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' -# ... with the exception of these: -exceptions: - - API - - ASP - - CLI - - CPU - - CSS - - CSV - - DEBUG - - DOM - - DPI - - FAQ - - GCC - - GDB - - GET - - GPU - - GTK - - GUI - - HTML - - HTTP - - HTTPS - - IDE - - JAR - - JSON - - JSX - - LESS - - LLDB - - NET - - NOTE - - NVDA - - OSS - - PATH - - PDF - - PHP - - POST - - RAM - - REPL - - RSA - - SCM - - SCSS - - SDK - - SQL - - SSH - - SSL - - SVG - - TBD - - TCP - - TODO - - URI - - URL - - USB - - UTF - - XML - - XSS - - YAML - - ZIP - - BOM - - AMQP - - AAD - - POSIX - - AKS - - PEM - - CRUD - - SAS - - JMS diff --git a/tutorials/.vale-styles/Microsoft/Adverbs.yml b/tutorials/.vale-styles/Microsoft/Adverbs.yml deleted file mode 100644 index 07d98d83..00000000 --- a/tutorials/.vale-styles/Microsoft/Adverbs.yml +++ /dev/null @@ -1,270 +0,0 @@ -extends: existence -message: "Consider removing '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: warning -action: - name: remove -tokens: - - abnormally - - absentmindedly - - accidentally - - adventurously - - anxiously - - arrogantly - - awkwardly - - bashfully - - beautifully - - bitterly - - bleakly - - blindly - - blissfully - - boastfully - - boldly - - bravely - - briefly - - brightly - - briskly - - broadly - - busily - - calmly - - carefully - - carelessly - - cautiously - - cheerfully - - cleverly - - closely - - coaxingly - - colorfully - - continually - - coolly - - courageously - - crossly - - cruelly - - curiously - - daintily - - dearly - - deceivingly - - deeply - - defiantly - - deliberately - - delightfully - - diligently - - dimly - - doubtfully - - dreamily - - easily - - elegantly - - energetically - - enormously - - enthusiastically - - excitedly - - extremely - - fairly - - faithfully - - famously - - ferociously - - fervently - - fiercely - - fondly - - foolishly - - fortunately - - frankly - - frantically - - freely - - frenetically - - frightfully - - furiously - - generally - - generously - - gently - - gladly - - gleefully - - gracefully - - gratefully - - greatly - - greedily - - happily - - hastily - - healthily - - heavily - - helplessly - - honestly - - hopelessly - - hungrily - - innocently - - inquisitively - - intensely - - intently - - interestingly - - inwardly - - irritably - - jaggedly - - jealously - - jovially - - joyfully - - joyously - - jubilantly - - judgmentally - - justly - - keenly - - kiddingly - - kindheartedly - - knavishly - - knowingly - - knowledgeably - - lazily - - lightly - - limply - - lively - - loftily - - longingly - - loosely - - loudly - - lovingly - - loyally - - madly - - majestically - - meaningfully - - mechanically - - merrily - - miserably - - mockingly - - mortally - - mysteriously - - naturally - - nearly - - neatly - - nervously - - nicely - - noisily - - obediently - - obnoxiously - - oddly - - offensively - - optimistically - - overconfidently - - painfully - - partially - - patiently - - perfectly - - playfully - - politely - - poorly - - positively - - potentially - - powerfully - - promptly - - properly - - punctually - - quaintly - - queasily - - queerly - - questionably - - quickly - - quietly - - quirkily - - quizzically - - randomly - - rapidly - - rarely - - readily - - really - - reassuringly - - recklessly - - regularly - - reluctantly - - repeatedly - - reproachfully - - restfully - - righteously - - rightfully - - rigidly - - roughly - - rudely - - safely - - scarcely - - scarily - - searchingly - - sedately - - seemingly - - selfishly - - separately - - seriously - - shakily - - sharply - - sheepishly - - shrilly - - shyly - - silently - - sleepily - - slowly - - smoothly - - softly - - solemnly - - solidly - - speedily - - stealthily - - sternly - - strictly - - suddenly - - supposedly - - surprisingly - - suspiciously - - sweetly - - swiftly - - sympathetically - - tenderly - - tensely - - terribly - - thankfully - - thoroughly - - thoughtfully - - tightly - - tremendously - - triumphantly - - truthfully - - ultimately - - unabashedly - - unaccountably - - unbearably - - unethically - - unexpectedly - - unfortunately - - unimpressively - - unnaturally - - unnecessarily - - urgently - - usefully - - uselessly - - utterly - - vacantly - - vaguely - - vainly - - valiantly - - vastly - - verbally - - very - - viciously - - victoriously - - violently - - vivaciously - - voluntarily - - warmly - - weakly - - wearily - - wetly - - wholly - - wildly - - willfully - - wisely - - woefully - - wonderfully - - worriedly - - yawningly - - yearningly - - yieldingly - - youthfully - - zealously - - zestfully - - zestily diff --git a/tutorials/.vale-styles/Microsoft/Auto.yml b/tutorials/.vale-styles/Microsoft/Auto.yml deleted file mode 100644 index 4da43935..00000000 --- a/tutorials/.vale-styles/Microsoft/Auto.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "In general, don't hyphenate '%s'." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto -ignorecase: true -level: error -action: - name: convert - params: - - simple -tokens: - - 'auto-\w+' diff --git a/tutorials/.vale-styles/Microsoft/Avoid.yml b/tutorials/.vale-styles/Microsoft/Avoid.yml deleted file mode 100644 index dab7822c..00000000 --- a/tutorials/.vale-styles/Microsoft/Avoid.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "Don't use '%s'. See the A-Z word list for details." -# See the A-Z word list -link: https://docs.microsoft.com/en-us/style-guide -ignorecase: true -level: error -tokens: - - abortion - - and so on - - app(?:lication)?s? (?:developer|program) - - app(?:lication)? file - - backbone - - backend - - contiguous selection diff --git a/tutorials/.vale-styles/Microsoft/ComplexWords.yml b/tutorials/.vale-styles/Microsoft/ComplexWords.yml deleted file mode 100644 index 65b7a347..00000000 --- a/tutorials/.vale-styles/Microsoft/ComplexWords.yml +++ /dev/null @@ -1,120 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: suggestion -action: - name: replace -swap: - "approximate(?:ly)?": about - abundance: plenty - accelerate: speed up - accentuate: stress - accompany: go with - accomplish: carry out|do - accorded: given - accordingly: so - accrue: add - accurate: right|exact - acquiesce: agree - acquire: get|buy - additional: more|extra - address: discuss - addressees: you - adjacent to: next to - adjustment: change - admissible: allowed - advantageous: helpful - advise: tell - aggregate: total - aircraft: plane - alleviate: ease - allocate: assign|divide - alternatively: or - alternatives: choices|options - ameliorate: improve - amend: change - anticipate: expect - apparent: clear|plain - ascertain: discover|find out - assistance: help - attain: meet - attempt: try - authorize: allow - belated: late - bestow: give - cease: stop|end - collaborate: work together - commence: begin - compensate: pay - component: part - comprise: form|include - concept: idea - concerning: about - confer: give|award - consequently: so - consolidate: merge - constitutes: forms - contains: has - convene: meet - demonstrate: show|prove - depart: leave - designate: choose - desire: want|wish - determine: decide|find - detrimental: bad|harmful - disclose: share|tell - discontinue: stop - disseminate: send|give - eliminate: end - elucidate: explain - employ: use - enclosed: inside|included - encounter: meet - endeavor: try - enumerate: count - equitable: fair - equivalent: equal - exclusively: only - expedite: hurry - facilitate: ease - females: women - finalize: complete|finish - frequently: often - identical: same - incorrect: wrong - indication: sign - initiate: start|begin - itemized: listed - jeopardize: risk - liaise: work with|partner with - maintain: keep|support - methodology: method - modify: change - monitor: check|watch - multiple: many - necessitate: cause - notify: tell - numerous: many - objective: aim|goal - obligate: bind|compel - optimum: best|most - permit: let - portion: part - possess: own - previous: earlier - previously: before - prioritize: rank - procure: buy - provide: give|offer - purchase: buy - relocate: move - solicit: request - state-of-the-art: latest - subsequent: later|next - substantial: large - sufficient: enough - terminate: end - transmit: send - utilization: use - utilize: use diff --git a/tutorials/.vale-styles/Microsoft/Contractions.yml b/tutorials/.vale-styles/Microsoft/Contractions.yml deleted file mode 100644 index ded330f7..00000000 --- a/tutorials/.vale-styles/Microsoft/Contractions.yml +++ /dev/null @@ -1,50 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions -level: error -ignorecase: true -action: - name: replace -swap: - are not: aren't - cannot: can't - could not: couldn't - did not: didn't - do not: don't - does not: doesn't - has not: hasn't - have not: haven't - how is: how's - is not: isn't - - 'it is(?!\.)': it's - 'it''s(?=\.)': it is - - should not: shouldn't - - 'that is(?!\.)': that's - 'that''s(?=\.)': that is - - 'they are(?!\.)': they're - 'they''re(?=\.)': they are - - was not: wasn't - - 'we are(?!\.)': we're - 'we''re(?=\.)': we are - - 'we have(?!\.)': we've - 'we''ve(?=\.)': we have - - were not: weren't - - 'what is(?!\.)': what's - 'what''s(?=\.)': what is - - 'when is(?!\.)': when's - 'when''s(?=\.)': when is - - 'where is(?!\.)': where's - 'where''s(?=\.)': where is - - will not: won't diff --git a/tutorials/.vale-styles/Microsoft/Dashes.yml b/tutorials/.vale-styles/Microsoft/Dashes.yml deleted file mode 100644 index 2894cf72..00000000 --- a/tutorials/.vale-styles/Microsoft/Dashes.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Remove the spaces around '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes -ignorecase: true -nonword: true -level: error -action: - name: edit - params: - - remove - - ' ' -tokens: - - '[—–]\s|\s[—–]' diff --git a/tutorials/.vale-styles/Microsoft/DateFormat.yml b/tutorials/.vale-styles/Microsoft/DateFormat.yml deleted file mode 100644 index 19653139..00000000 --- a/tutorials/.vale-styles/Microsoft/DateFormat.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: Use 'July 31, 2016' format, not '%s'. -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms -ignorecase: true -level: error -nonword: true -tokens: - - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/tutorials/.vale-styles/Microsoft/DateNumbers.yml b/tutorials/.vale-styles/Microsoft/DateNumbers.yml deleted file mode 100644 index 14d46747..00000000 --- a/tutorials/.vale-styles/Microsoft/DateNumbers.yml +++ /dev/null @@ -1,40 +0,0 @@ -extends: existence -message: "Don't use ordinal numbers for dates." -link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates -level: error -nonword: true -ignorecase: true -raw: - - \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s* -tokens: - - first - - second - - third - - fourth - - fifth - - sixth - - seventh - - eighth - - ninth - - tenth - - eleventh - - twelfth - - thirteenth - - fourteenth - - fifteenth - - sixteenth - - seventeenth - - eighteenth - - nineteenth - - twentieth - - twenty-first - - twenty-second - - twenty-third - - twenty-fourth - - twenty-fifth - - twenty-sixth - - twenty-seventh - - twenty-eighth - - twenty-ninth - - thirtieth - - thirty-first diff --git a/tutorials/.vale-styles/Microsoft/DateOrder.yml b/tutorials/.vale-styles/Microsoft/DateOrder.yml deleted file mode 100644 index 12d69ba5..00000000 --- a/tutorials/.vale-styles/Microsoft/DateOrder.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Always spell out the name of the month." -link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates -ignorecase: true -level: error -nonword: true -tokens: - - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b' diff --git a/tutorials/.vale-styles/Microsoft/Ellipses.yml b/tutorials/.vale-styles/Microsoft/Ellipses.yml deleted file mode 100644 index 320457a8..00000000 --- a/tutorials/.vale-styles/Microsoft/Ellipses.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "In general, don't use an ellipsis." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses -nonword: true -level: warning -action: - name: remove -tokens: - - '\.\.\.' diff --git a/tutorials/.vale-styles/Microsoft/FirstPerson.yml b/tutorials/.vale-styles/Microsoft/FirstPerson.yml deleted file mode 100644 index 77761af8..00000000 --- a/tutorials/.vale-styles/Microsoft/FirstPerson.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: existence -message: "Use first person (such as '%s') sparingly." -link: https://docs.microsoft.com/en-us/style-guide/grammar/person -ignorecase: true -level: warning -nonword: true -tokens: - - (?:^|\s)I\s - - (?:^|\s)I,\s - - \bI'd\b - - \bI'll\b - - \bI'm\b - - \bI've\b - - \bme\b - - \bmy\b - - \bmine\b diff --git a/tutorials/.vale-styles/Microsoft/Foreign.yml b/tutorials/.vale-styles/Microsoft/Foreign.yml deleted file mode 100644 index d37835a5..00000000 --- a/tutorials/.vale-styles/Microsoft/Foreign.yml +++ /dev/null @@ -1,12 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words -ignorecase: true -level: error -nonword: true -action: - name: replace -swap: - '\b(?:eg|e\.g\.)[\s,]': for example - '\b(?:ie|i\.e\.)[\s,]': that is - diff --git a/tutorials/.vale-styles/Microsoft/Gender.yml b/tutorials/.vale-styles/Microsoft/Gender.yml deleted file mode 100644 index 47c08024..00000000 --- a/tutorials/.vale-styles/Microsoft/Gender.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Don't use '%s'." -link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender -level: error -ignorecase: true -tokens: - - he/she - - s/he diff --git a/tutorials/.vale-styles/Microsoft/GenderBias.yml b/tutorials/.vale-styles/Microsoft/GenderBias.yml deleted file mode 100644 index 3d873aa3..00000000 --- a/tutorials/.vale-styles/Microsoft/GenderBias.yml +++ /dev/null @@ -1,44 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -ignorecase: true -level: error -swap: - (?:alumna|alumnus): graduate - (?:alumnae|alumni): graduates - air(?:m[ae]n|wom[ae]n): pilot(s) - anchor(?:m[ae]n|wom[ae]n): anchor(s) - authoress: author - camera(?:m[ae]n|wom[ae]n): camera operator(s) - chair(?:m[ae]n|wom[ae]n): chair(s) - congress(?:m[ae]n|wom[ae]n): member(s) of congress - door(?:m[ae]|wom[ae]n): concierge(s) - draft(?:m[ae]n|wom[ae]n): drafter(s) - fire(?:m[ae]n|wom[ae]n): firefighter(s) - fisher(?:m[ae]n|wom[ae]n): fisher(s) - fresh(?:m[ae]n|wom[ae]n): first-year student(s) - garbage(?:m[ae]n|wom[ae]n): waste collector(s) - lady lawyer: lawyer - ladylike: courteous - landlord: building manager - mail(?:m[ae]n|wom[ae]n): mail carriers - man and wife: husband and wife - man enough: strong enough - mankind: human kind - manmade: manufactured - manpower: personnel - men and girls: men and women - middle(?:m[ae]n|wom[ae]n): intermediary - news(?:m[ae]n|wom[ae]n): journalist(s) - ombuds(?:man|woman): ombuds - oneupmanship: upstaging - poetess: poet - police(?:m[ae]n|wom[ae]n): police officer(s) - repair(?:m[ae]n|wom[ae]n): technician(s) - sales(?:m[ae]n|wom[ae]n): salesperson or sales people - service(?:m[ae]n|wom[ae]n): soldier(s) - steward(?:ess)?: flight attendant - tribes(?:m[ae]n|wom[ae]n): tribe member(s) - waitress: waiter - woman doctor: doctor - woman scientist[s]?: scientist(s) - work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/tutorials/.vale-styles/Microsoft/GeneralURL.yml b/tutorials/.vale-styles/Microsoft/GeneralURL.yml deleted file mode 100644 index dcef503d..00000000 --- a/tutorials/.vale-styles/Microsoft/GeneralURL.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "For a general audience, use 'address' rather than 'URL'." -link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses -level: warning -action: - name: replace - params: - - URL - - address -tokens: - - URL diff --git a/tutorials/.vale-styles/Microsoft/HeadingAcronyms.yml b/tutorials/.vale-styles/Microsoft/HeadingAcronyms.yml deleted file mode 100644 index 6c91e662..00000000 --- a/tutorials/.vale-styles/Microsoft/HeadingAcronyms.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "Avoid using acronyms in a title or heading." -link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acronyms-in-titles-and-headings -level: warning -scope: heading -tokens: - - '[A-Z]{2,4}' -exceptions: - - SDK - - AD - - SAS - - BOM - - JMS - - API diff --git a/tutorials/.vale-styles/Microsoft/HeadingColons.yml b/tutorials/.vale-styles/Microsoft/HeadingColons.yml deleted file mode 100644 index 7013c391..00000000 --- a/tutorials/.vale-styles/Microsoft/HeadingColons.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Capitalize '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons -nonword: true -level: error -scope: heading -tokens: - - ':\s[a-z]' diff --git a/tutorials/.vale-styles/Microsoft/HeadingPunctuation.yml b/tutorials/.vale-styles/Microsoft/HeadingPunctuation.yml deleted file mode 100644 index af04b02e..00000000 --- a/tutorials/.vale-styles/Microsoft/HeadingPunctuation.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't use end punctuation in headings." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -nonword: true -level: warning -scope: heading -action: - name: edit - params: - - remove - - '.?!' -tokens: - - '[a-z][.?!](?:\s|$)' diff --git a/tutorials/.vale-styles/Microsoft/Headings.yml b/tutorials/.vale-styles/Microsoft/Headings.yml deleted file mode 100644 index 63624edc..00000000 --- a/tutorials/.vale-styles/Microsoft/Headings.yml +++ /dev/null @@ -1,28 +0,0 @@ -extends: capitalization -message: "'%s' should use sentence-style capitalization." -link: https://docs.microsoft.com/en-us/style-guide/capitalization -level: suggestion -scope: heading -match: $sentence -indicators: - - ':' -exceptions: - - Azure - - CLI - - Code - - Cosmos - - Docker - - Emmet - - I - - Kubernetes - - Linux - - macOS - - Marketplace - - MongoDB - - REPL - - Studio - - TypeScript - - URLs - - Visual - - VS - - Windows diff --git a/tutorials/.vale-styles/Microsoft/Hyphens.yml b/tutorials/.vale-styles/Microsoft/Hyphens.yml deleted file mode 100644 index 90bbb5de..00000000 --- a/tutorials/.vale-styles/Microsoft/Hyphens.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "'%s' doesn't need a hyphen." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens -level: warning -ignorecase: false -nonword: true -action: - name: edit - params: - - replace - - '-' - - ' ' -tokens: - - '\s[^\s-]+ly-' diff --git a/tutorials/.vale-styles/Microsoft/Negative.yml b/tutorials/.vale-styles/Microsoft/Negative.yml deleted file mode 100644 index d6ff2f22..00000000 --- a/tutorials/.vale-styles/Microsoft/Negative.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Form a negative number with an en dash, not a hyphen." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '-' - - '–' -tokens: - - '\s-\d+\s' diff --git a/tutorials/.vale-styles/Microsoft/Ordinal.yml b/tutorials/.vale-styles/Microsoft/Ordinal.yml deleted file mode 100644 index e3483e38..00000000 --- a/tutorials/.vale-styles/Microsoft/Ordinal.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't add -ly to an ordinal number." -link: https://docs.microsoft.com/en-us/style-guide/numbers -level: error -action: - name: edit - params: - - trim - - ly -tokens: - - firstly - - secondly - - thirdly diff --git a/tutorials/.vale-styles/Microsoft/OxfordComma.yml b/tutorials/.vale-styles/Microsoft/OxfordComma.yml deleted file mode 100644 index 493b55c3..00000000 --- a/tutorials/.vale-styles/Microsoft/OxfordComma.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Use the Oxford comma in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas -scope: sentence -level: suggestion -nonword: true -tokens: - - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' diff --git a/tutorials/.vale-styles/Microsoft/Passive.yml b/tutorials/.vale-styles/Microsoft/Passive.yml deleted file mode 100644 index 102d377c..00000000 --- a/tutorials/.vale-styles/Microsoft/Passive.yml +++ /dev/null @@ -1,183 +0,0 @@ -extends: existence -message: "'%s' looks like passive voice." -ignorecase: true -level: suggestion -raw: - - \b(am|are|were|being|is|been|was|be)\b\s* -tokens: - - '[\w]+ed' - - awoken - - beat - - become - - been - - begun - - bent - - beset - - bet - - bid - - bidden - - bitten - - bled - - blown - - born - - bought - - bound - - bred - - broadcast - - broken - - brought - - built - - burnt - - burst - - cast - - caught - - chosen - - clung - - come - - cost - - crept - - cut - - dealt - - dived - - done - - drawn - - dreamt - - driven - - drunk - - dug - - eaten - - fallen - - fed - - felt - - fit - - fled - - flown - - flung - - forbidden - - foregone - - forgiven - - forgotten - - forsaken - - fought - - found - - frozen - - given - - gone - - gotten - - ground - - grown - - heard - - held - - hidden - - hit - - hung - - hurt - - kept - - knelt - - knit - - known - - laid - - lain - - leapt - - learnt - - led - - left - - lent - - let - - lighted - - lost - - made - - meant - - met - - misspelt - - mistaken - - mown - - overcome - - overdone - - overtaken - - overthrown - - paid - - pled - - proven - - put - - quit - - read - - rid - - ridden - - risen - - run - - rung - - said - - sat - - sawn - - seen - - sent - - set - - sewn - - shaken - - shaven - - shed - - shod - - shone - - shorn - - shot - - shown - - shrunk - - shut - - slain - - slept - - slid - - slit - - slung - - smitten - - sold - - sought - - sown - - sped - - spent - - spilt - - spit - - split - - spoken - - spread - - sprung - - spun - - stolen - - stood - - stridden - - striven - - struck - - strung - - stuck - - stung - - stunk - - sung - - sunk - - swept - - swollen - - sworn - - swum - - swung - - taken - - taught - - thought - - thrived - - thrown - - thrust - - told - - torn - - trodden - - understood - - upheld - - upset - - wed - - wept - - withheld - - withstood - - woken - - won - - worn - - wound - - woven - - written - - wrung diff --git a/tutorials/.vale-styles/Microsoft/Percentages.yml b/tutorials/.vale-styles/Microsoft/Percentages.yml deleted file mode 100644 index b68a7363..00000000 --- a/tutorials/.vale-styles/Microsoft/Percentages.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use a numeral plus the units." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -tokens: - - '\b[a-zA-z]+\spercent\b' diff --git a/tutorials/.vale-styles/Microsoft/Quotes.yml b/tutorials/.vale-styles/Microsoft/Quotes.yml deleted file mode 100644 index 38f49760..00000000 --- a/tutorials/.vale-styles/Microsoft/Quotes.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: 'Punctuation should be inside the quotes.' -link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks -level: error -nonword: true -tokens: - - '["“][^"”“]+["”][.,]' diff --git a/tutorials/.vale-styles/Microsoft/RangeFormat.yml b/tutorials/.vale-styles/Microsoft/RangeFormat.yml deleted file mode 100644 index f1d736e9..00000000 --- a/tutorials/.vale-styles/Microsoft/RangeFormat.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Use an en dash in a range of numbers." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '-' - - '–' -tokens: - - '\b\d+\s?[-]\s?\d+\b' diff --git a/tutorials/.vale-styles/Microsoft/RangeTime.yml b/tutorials/.vale-styles/Microsoft/RangeTime.yml deleted file mode 100644 index cdd4b334..00000000 --- a/tutorials/.vale-styles/Microsoft/RangeTime.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Use 'to' instead of a dash in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - replace - - '[-–]' - - 'to' -tokens: - - '\b(?:AM|PM)\s?[-–]\s?.+(?:AM|PM)\b' diff --git a/tutorials/.vale-styles/Microsoft/Ranges.yml b/tutorials/.vale-styles/Microsoft/Ranges.yml deleted file mode 100644 index 67d9702b..00000000 --- a/tutorials/.vale-styles/Microsoft/Ranges.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "In most cases, use 'from' or 'through' to describe a range of numbers." -link: 'https://docs.microsoft.com/en-us/style-guide/numbers' -nonword: true -level: warning -tokens: - - '\b\d+\s?[-–]\s?\d+\b' diff --git a/tutorials/.vale-styles/Microsoft/Semicolon.yml b/tutorials/.vale-styles/Microsoft/Semicolon.yml deleted file mode 100644 index 4d905467..00000000 --- a/tutorials/.vale-styles/Microsoft/Semicolon.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Try to simplify this sentence." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/semicolons -nonword: true -scope: sentence -level: suggestion -tokens: - - ';' diff --git a/tutorials/.vale-styles/Microsoft/SentenceLength.yml b/tutorials/.vale-styles/Microsoft/SentenceLength.yml deleted file mode 100644 index f248cf05..00000000 --- a/tutorials/.vale-styles/Microsoft/SentenceLength.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: occurrence -message: "Try to keep sentences short (< 30 words)." -scope: sentence -level: suggestion -max: 30 -token: \b(\w+)\b - diff --git a/tutorials/.vale-styles/Microsoft/Spacing.yml b/tutorials/.vale-styles/Microsoft/Spacing.yml deleted file mode 100644 index 4189306f..00000000 --- a/tutorials/.vale-styles/Microsoft/Spacing.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: existence -message: "'%s' should have one space." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -level: error -nonword: true -tokens: - - '[a-z][.?!] {2,}[A-Z]' - - '[a-z][.?!][A-Z]' -exceptions: - - \ No newline at end of file diff --git a/tutorials/.vale-styles/Microsoft/Suspended.yml b/tutorials/.vale-styles/Microsoft/Suspended.yml deleted file mode 100644 index 7282e9c9..00000000 --- a/tutorials/.vale-styles/Microsoft/Suspended.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't use '%s' unless space is limited." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens -ignorecase: true -level: warning -tokens: - - '\w+- and \w+-' diff --git a/tutorials/.vale-styles/Microsoft/Terms.yml b/tutorials/.vale-styles/Microsoft/Terms.yml deleted file mode 100644 index e41ff74b..00000000 --- a/tutorials/.vale-styles/Microsoft/Terms.yml +++ /dev/null @@ -1,43 +0,0 @@ -extends: substitution -message: "Prefer '%s' over '%s'." -level: warning -ignorecase: true -action: - name: replace -swap: - '(?:agent|virtual assistant|intelligent personal assistant)': personal digital assistant - '(?:drive C:|drive C>|C: drive)': drive C - '(?:internet bot|web robot)s?': bot(s) - '(?:microsoft cloud|the cloud)': cloud - '(?:mobile|smart) ?phone': phone - '24/7': every day - 'audio(?:-| )book': audiobook - 'back(?:-| )light': backlight - 'chat ?bots?': chatbot(s) - adaptor: adapter - administrate: administer - afterwards: afterward - alphabetic: alphabetical - alphanumerical: alphanumeric - anti-aliasing: antialiasing - anti-malware: antimalware - anti-spyware: antispyware - anti-virus: antivirus - appendixes: appendices - artificial intelligence: artificial intelligence - assembler: assembly language - bpp: bpp - bps: bps - caap: CaaP - conversation-as-a-platform: conversation as a platform - eb: EB - gb: GB - gbps: Gbps - kb: KB - keypress: keystroke - mb: MB - pb: PB - tb: TB - zb: ZB - viz: namely - ergo: therefore diff --git a/tutorials/.vale-styles/Microsoft/URLFormat.yml b/tutorials/.vale-styles/Microsoft/URLFormat.yml deleted file mode 100644 index 82e702f9..00000000 --- a/tutorials/.vale-styles/Microsoft/URLFormat.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -ignorecase: true -level: error -action: - name: replace -swap: - URL for: URL of - an URL: a URL - diff --git a/tutorials/.vale-styles/Microsoft/Units.yml b/tutorials/.vale-styles/Microsoft/Units.yml deleted file mode 100644 index f062418e..00000000 --- a/tutorials/.vale-styles/Microsoft/Units.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: existence -message: "Don't spell out the number in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/units-of-measure-terms -level: error -raw: - - '[a-zA-Z]+\s' -tokens: - - '(?:centi|milli)?meters' - - '(?:kilo)?grams' - - '(?:kilo)?meters' - - '(?:mega)?pixels' - - cm - - inches - - lb - - miles - - pounds diff --git a/tutorials/.vale-styles/Microsoft/Vocab.yml b/tutorials/.vale-styles/Microsoft/Vocab.yml deleted file mode 100644 index eebe97b1..00000000 --- a/tutorials/.vale-styles/Microsoft/Vocab.yml +++ /dev/null @@ -1,25 +0,0 @@ -extends: existence -message: "Verify your use of '%s' with the A-Z word list." -link: 'https://docs.microsoft.com/en-us/style-guide' -level: suggestion -ignorecase: true -tokens: - - above - - accessible - - actionable - - against - - alarm - - alert - - alias - - allows? - - and/or - - as well as - - assure - - author - - avg - - beta - - ensure - - he - - insure - - sample - - she diff --git a/tutorials/.vale-styles/Microsoft/We.yml b/tutorials/.vale-styles/Microsoft/We.yml deleted file mode 100644 index 97c901c1..00000000 --- a/tutorials/.vale-styles/Microsoft/We.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Try to avoid using first-person plural like '%s'." -link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural -level: warning -ignorecase: true -tokens: - - we - - we'(?:ve|re) - - ours? - - us - - let's diff --git a/tutorials/.vale-styles/Microsoft/Wordiness.yml b/tutorials/.vale-styles/Microsoft/Wordiness.yml deleted file mode 100644 index 22a4c932..00000000 --- a/tutorials/.vale-styles/Microsoft/Wordiness.yml +++ /dev/null @@ -1,122 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: warning -action: - name: replace -swap: - (?:give|gave) rise to: lead to - (?:previous|prior) to: before - a (?:large)? majority of: most - a (?:large)? number of: many - a myriad of: myriad - adversely impact: hurt - all across: across - all of a sudden: suddenly - all of these: these - all of: all - all-time record: record - almost all: most - almost never: seldom - along the lines of: similar to - an adequate number of: enough - an appreciable number of: many - an estimated: about - any and all: all - are in agreement: agree - as a matter of fact: in fact - as a means of: to - as a result of: because of - as of yet: yet - as per: per - at a later date: later - at all times: always - at the present time: now - at this point in time: at this point - based in large part on: based on - based on the fact that: because - basic necessity: necessity - because of the fact that: because - came to a realization: realized - came to an abrupt end: ended abruptly - carry out an evaluation of: evaluate - close down: close - closed down: closed - complete stranger: stranger - completely separate: separate - concerning the matter of: regarding - conduct a review of: review - conduct an investigation: investigate - conduct experiments: experiment - continue on: continue - despite the fact that: although - disappear from sight: disappear - drag and drop: drag - drag-and-drop: drag - doomed to fail: doomed - due to the fact that: because - during the period of: during - during the time that: while - emergency situation: emergency - except when: unless - excessive number: too many - extend an invitation: invite - fall down: fall - fell down: fell - for the duration of: during - gather together: gather - has the ability to: can - has the capacity to: can - has the opportunity to: could - hold a meeting: meet - if this is not the case: if not - in a careful manner: carefully - in a thoughtful manner: thoughtfully - in a timely manner: timely - in an effort to: to - in between: between - in lieu of: instead of - in many cases: often - in most cases: usually - in order to: to - in some cases: sometimes - in spite of the fact that: although - in spite of: despite - in the (?:very)? near future: soon - in the event that: if - in the neighborhood of: roughly - in the vicinity of: close to - it would appear that: apparently - lift up: lift - made reference to: referred to - make reference to: refer to - mix together: mix - none at all: none - not in a position to: unable - not possible: impossible - of major importance: important - perform an assessment of: assess - pertaining to: about - place an order: order - plays a key role in: is essential to - present time: now - readily apparent: apparent - some of the: some - span across: span - subsequent to: after - successfully complete: complete - sufficient number (?:of)?: enough - take action: act - take into account: consider - the question as to whether: whether - there is no doubt but that: doubtless - this day and age: this age - this is a subject that: this subject - time (?:frame|period): time - under the provisions of: under - until such time as: until - used for fuel purposes: used for fuel - whether or not: whether - with regard to: regarding - with the exception of: except for diff --git a/tutorials/.vale-styles/Microsoft/meta.json b/tutorials/.vale-styles/Microsoft/meta.json deleted file mode 100644 index 297719bb..00000000 --- a/tutorials/.vale-styles/Microsoft/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/errata-ai/Microsoft/releases.atom", - "vale_version": ">=1.0.0" -} diff --git a/tutorials/.vale.ini b/tutorials/.vale.ini deleted file mode 100644 index 6574c688..00000000 --- a/tutorials/.vale.ini +++ /dev/null @@ -1,20 +0,0 @@ -# Core properties -#---------------- -# Specify where to find styles -StylesPath = .vale-styles - -# Specify the minimum alert level to report -# Alerts are assigned a level of suggestion, warning, or error. -# For local use it's good to see all the suggestions and warnings. -MinAlertLevel = suggestion - -# Specify how to test a particular type of files -#----------------------------------------------- -[*.{adoc,md}] - -# Vale comes with three built-in styles: write-good, proselint, and Joblint. -# You could enable all rules in the "Microsoft" style guide as follows: -# BasedOnStyles = Microsoft -BasedOnStyles = Microsoft - -Microsoft.Headings = NO diff --git a/tutorials/README.adoc b/tutorials/README.adoc deleted file mode 100644 index a83ae683..00000000 --- a/tutorials/README.adoc +++ /dev/null @@ -1 +0,0 @@ -This project is used to manage docs displayed in the https://microsoft.github.io/spring-cloud-azure[GitHub Pages] \ No newline at end of file diff --git a/tutorials/pom.xml b/tutorials/pom.xml deleted file mode 100644 index 06f9ab8a..00000000 --- a/tutorials/pom.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - 4.0.0 - - - com.azure.spring - spring-cloud-azure-docs - 4.1.0-beta.1 - ../pom.xml - - - spring-cloud-azure-docs-tutorials - spring-cloud-azure-docs-tutorials - - - ${project.build.directory}/generated-docs/${project.version}/tutorials/html - - - diff --git a/tutorials/src/main/.gitignore b/tutorials/src/main/.gitignore deleted file mode 100644 index acf32da4..00000000 --- a/tutorials/src/main/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -META-INF/ -org/ \ No newline at end of file diff --git a/tutorials/src/main/asciidoc/_attributes.adoc b/tutorials/src/main/asciidoc/_attributes.adoc deleted file mode 100644 index 201f33bb..00000000 --- a/tutorials/src/main/asciidoc/_attributes.adoc +++ /dev/null @@ -1,16 +0,0 @@ -:doctype: book -:idprefix: -:idseparator: - -:toc: left -:toclevels: 4 -:tabsize: 4 -:numbered: -:sectanchors: -:sectnums: -:icons: font -:hide-uri-scheme: -:docinfo: shared,private - -:sc-ext: java -:project-full-name: Spring Cloud Azure -:all: {asterisk}{asterisk} diff --git a/tutorials/src/main/asciidoc/docinfo.html b/tutorials/src/main/asciidoc/docinfo.html deleted file mode 100644 index 1b364b3c..00000000 --- a/tutorials/src/main/asciidoc/docinfo.html +++ /dev/null @@ -1,2 +0,0 @@ - -