Add more modules: profile, getting-started, samples, tutorial (#906)
This commit is contained in:
Rujun Chen
GitHub
Родитель
437ee87c52
Коммит
0e022a77b2
|
|
@ -4,24 +4,15 @@ on:
|
|||
push:
|
||||
branches:
|
||||
- main
|
||||
- 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
|
||||
- hotfix/*
|
||||
|
||||
jobs:
|
||||
updateDocs:
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- run: |
|
||||
|
||||
- name: Install azure-sdk-for-java
|
||||
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
|
||||
|
|
@ -39,11 +30,15 @@ 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
|
||||
- run: |
|
||||
|
||||
- name: Config git
|
||||
run: |
|
||||
git config user.name github-actions
|
||||
git config user.email github-actions@github.com
|
||||
|
||||
|
|
@ -62,28 +57,5 @@ 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: |
|
||||
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
|
||||
run: ./scripts/update_gh-pages_branch.sh --build
|
||||
|
|
|
|||
|
|
@ -1,6 +0,0 @@
|
|||
#!/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
|
||||
308
docs/pom.xml
308
docs/pom.xml
|
|
@ -1,308 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<parent>
|
||||
<groupId>com.azure.spring</groupId>
|
||||
<artifactId>spring-cloud-azure-aggregator</artifactId>
|
||||
<version>4.1.0-beta.1</version>
|
||||
<relativePath>../pom.xml</relativePath>
|
||||
</parent>
|
||||
|
||||
<artifactId>spring-cloud-azure-build-docs</artifactId>
|
||||
<name>spring-cloud-azure-build-docs</name>
|
||||
<packaging>jar</packaging>
|
||||
<description>Spring Cloud Azure Build Docs</description>
|
||||
|
||||
<properties>
|
||||
<docs.main>spring-cloud-azure</docs.main>
|
||||
<main.basedir>${basedir}/..</main.basedir>
|
||||
<docs.whitelisted.branches>${project.version}</docs.whitelisted.branches>
|
||||
<upload-docs-zip.phase>none</upload-docs-zip.phase>
|
||||
<generated-docs-multipage-output.dir>${project.build.directory}/generated-docs/${project.version}/reference/html</generated-docs-multipage-output.dir>
|
||||
<generated-docs-singlepage-output.dir>${project.build.directory}/generated-docs/${project.version}/reference/htmlsingle</generated-docs-singlepage-output.dir>
|
||||
<generated-docs-pdf-output.dir>${project.build.directory}/generated-docs/${project.version}/reference/pdf</generated-docs-pdf-output.dir>
|
||||
</properties>
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>spring-milestones</id>
|
||||
<name>Spring Milestones</name>
|
||||
<url>https://repo.spring.io/milestone</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
<repository>
|
||||
<id>spring-releases</id>
|
||||
<name>Spring Releases</name>
|
||||
<url>https://repo.spring.io/release</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
</repositories>
|
||||
<pluginRepositories>
|
||||
<pluginRepository>
|
||||
<id>spring-milestones</id>
|
||||
<name>Spring Milestones</name>
|
||||
<url>https://repo.spring.io/milestone</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</pluginRepository>
|
||||
<pluginRepository>
|
||||
<id>spring-releases</id>
|
||||
<name>Spring Releases</name>
|
||||
<url>https://repo.spring.io/release</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</pluginRepository>
|
||||
</pluginRepositories>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.azure.spring</groupId>
|
||||
<artifactId>spring-cloud-azure-starter</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.azure.spring</groupId>
|
||||
<artifactId>spring-cloud-azure-starter-stream-eventhubs</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.azure.spring</groupId>
|
||||
<artifactId>spring-cloud-azure-starter-stream-servicebus</artifactId>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<artifactId>maven-deploy-plugin</artifactId>
|
||||
<configuration>
|
||||
<skip>true</skip>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>docs</id>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>pl.project13.maven</groupId>
|
||||
<artifactId>git-commit-id-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-dependency-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-resources-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.codehaus.mojo</groupId>
|
||||
<artifactId>exec-maven-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>generate-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops.adoc</argument>
|
||||
<argument>spring.jms.servicebus.*|spring.cloud.azure.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-global-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_global.adoc</argument>
|
||||
<argument>spring.cloud.azure.(client|credential|profile|proxy|retry).*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-aad-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_aad.adoc</argument>
|
||||
<argument>spring.cloud.azure.active-directory.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-aadb2c-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_aadb2c.adoc</argument>
|
||||
<argument>spring.cloud.azure.active-directory.b2c.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-appconf-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_appconf.adoc</argument>
|
||||
<argument>spring.cloud.azure.appconfiguration.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-cosmos-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_cosmos.adoc</argument>
|
||||
<argument>spring.cloud.azure.cosmos.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-eventhubs-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_eventhubs.adoc</argument>
|
||||
<argument>spring.cloud.azure.eventhubs.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-kv-secret-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_kv_secret.adoc</argument>
|
||||
<argument>spring.cloud.azure.keyvault.secret.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-kv-certificate-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_kv_certificate.adoc</argument>
|
||||
<argument>spring.cloud.azure.keyvault.certificate.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-servicebus-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_servicebus.adoc</argument>
|
||||
<argument>spring.cloud.azure.servicebus.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-servicebus-jms-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_servicebus_jms.adoc</argument>
|
||||
<argument>spring.jms.servicebus.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-storage-blob-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_storage_blob.adoc</argument>
|
||||
<argument>spring.cloud.azure.storage.blob.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-storage-fileshare-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_storage_fileshare.adoc</argument>
|
||||
<argument>spring.cloud.azure.storage.fileshare.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>generate-storage-queue-configprops</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>java</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>
|
||||
<argument>${project.basedir}/src/main/asciidoc/spring-cloud-azure/_configprops_storage_queue.adoc</argument>
|
||||
<argument>spring.cloud.azure.storage.queue.*</argument>
|
||||
</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctor-maven-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-antrun-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<artifactId>maven-deploy-plugin</artifactId>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</profile>
|
||||
</profiles>
|
||||
</project>
|
||||
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
|
||||
= 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.
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
include::_attributes.adoc[]
|
||||
|
||||
= Spring Cloud Azure
|
||||
|
||||
include::getting-started-guides.adoc[]
|
||||
include::tutorials.adoc[]
|
||||
include::samples.adoc[]
|
||||
include::reference.adoc[]
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
|
||||
= 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]
|
||||
|
|
@ -1,75 +0,0 @@
|
|||
|
||||
|===
|
||||
|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.
|
||||
|
||||
|===
|
||||
|
|
@ -1,74 +0,0 @@
|
|||
|
||||
|===
|
||||
|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.
|
||||
|
||||
|===
|
||||
|
|
@ -1,74 +0,0 @@
|
|||
|
||||
|===
|
||||
|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.
|
||||
|
||||
|===
|
||||
|
|
@ -1,66 +0,0 @@
|
|||
|
||||
[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[]
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<parent>
|
||||
<groupId>com.azure.spring</groupId>
|
||||
<artifactId>spring-cloud-azure-docs</artifactId>
|
||||
<version>4.1.0-beta.1</version>
|
||||
<relativePath>../pom.xml</relativePath>
|
||||
</parent>
|
||||
|
||||
<artifactId>spring-cloud-azure-docs-getting-started</artifactId>
|
||||
<version>4.1.0-beta.1</version>
|
||||
|
||||
<properties>
|
||||
<docs.output.directory>${project.build.directory}/generated-docs/${project.version}/getting-started/html</docs.output.directory>
|
||||
</properties>
|
||||
|
||||
</project>
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
|
||||
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.
|
||||
329
pom.xml
329
pom.xml
|
|
@ -1,228 +1,117 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
~ Copyright 2013-2019 the original author or authors.
|
||||
~
|
||||
~ Licensed under the Apache License, Version 2.0 (the "License");
|
||||
~ you may not use this file except in compliance with the License.
|
||||
~ You may obtain a copy of the License at
|
||||
~
|
||||
~ https://www.apache.org/licenses/LICENSE-2.0
|
||||
~
|
||||
~ Unless required by applicable law or agreed to in writing, software
|
||||
~ distributed under the License is distributed on an "AS IS" BASIS,
|
||||
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
~ See the License for the specific language governing permissions and
|
||||
~ limitations under the License.
|
||||
-->
|
||||
<project
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-build</artifactId>
|
||||
<version>3.1.1</version>
|
||||
<relativePath /> <!-- lookup parent from repository -->
|
||||
</parent>
|
||||
<groupId>com.azure.spring</groupId>
|
||||
<artifactId>spring-cloud-azure-docs</artifactId>
|
||||
<version>4.1.0-beta.1</version>
|
||||
<packaging>pom</packaging>
|
||||
|
||||
<groupId>com.azure.spring</groupId>
|
||||
<artifactId>spring-cloud-azure-aggregator</artifactId>
|
||||
<version>4.1.0-beta.1</version>
|
||||
<packaging>pom</packaging>
|
||||
<name>Spring Cloud Azure</name>
|
||||
<description>Spring Cloud Azure</description>
|
||||
<modules>
|
||||
<module>portal</module>
|
||||
<module>reference</module>
|
||||
<module>getting-started</module>
|
||||
<module>samples</module>
|
||||
<module>tutorials</module>
|
||||
</modules>
|
||||
|
||||
<properties>
|
||||
<spring-doc-resources.version>0.2.5</spring-doc-resources.version>
|
||||
<docs.build.directory>${project.build.directory}/docs/</docs.build.directory>
|
||||
<docs.output.directory>${project.build.directory}/generated-docs/html</docs.output.directory>
|
||||
</properties>
|
||||
|
||||
<properties>
|
||||
<!-- <tomcat.version>8.0.33</tomcat.version> -->
|
||||
<!-- <javax-mail.version>1.5.5</javax-mail.version> -->
|
||||
<maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
|
||||
<!-- <javax.activation.version>1.2.0</javax.activation.version> -->
|
||||
<spring-cloud-commons.version>3.1.1</spring-cloud-commons.version>
|
||||
<!-- "version.spring.cloud.azure" is used to update "_configprops.adoc".
|
||||
-->
|
||||
<version.spring.cloud.azure>4.1.0-beta.1</version.spring.cloud.azure>
|
||||
<spring-javaformat.version>0.0.29</spring-javaformat.version>
|
||||
<maven.compiler.source>1.8</maven.compiler.source>
|
||||
<maven.compiler.target>1.8</maven.compiler.target>
|
||||
</properties>
|
||||
|
||||
<modules>
|
||||
<module>docs</module>
|
||||
</modules>
|
||||
|
||||
<dependencyManagement>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.azure.spring</groupId>
|
||||
<artifactId>spring-cloud-azure-dependencies</artifactId>
|
||||
<version>${version.spring.cloud.azure}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-commons-dependencies</artifactId>
|
||||
<version>${spring-cloud-commons.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
|
||||
</dependencies>
|
||||
</dependencyManagement>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.slf4j</groupId>
|
||||
<artifactId>slf4j-api</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-test</artifactId>
|
||||
<scope>test</scope>
|
||||
<exclusions>
|
||||
<exclusion>
|
||||
<groupId>org.junit.vintage</groupId>
|
||||
<artifactId>junit-vintage-engine</artifactId>
|
||||
</exclusion>
|
||||
<exclusion>
|
||||
<groupId>junit</groupId>
|
||||
<artifactId>junit</artifactId>
|
||||
</exclusion>
|
||||
</exclusions>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<build>
|
||||
<pluginManagement>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<artifactId>maven-compiler-plugin</artifactId>
|
||||
<configuration>
|
||||
<compilerArgs>
|
||||
<!-- Enable all warnings -->
|
||||
<compilerArg>-Xlint:all</compilerArg>
|
||||
<!-- Disable options warning because we will have differences between the compiler and source code level-->
|
||||
<compilerArg>-Xlint:-options</compilerArg>
|
||||
<!-- Disable serialversionuid warnings -->
|
||||
<compilerArg>-Xlint:-serial</compilerArg>
|
||||
<!--compilerArg>-Werror</compilerArg-->
|
||||
</compilerArgs>
|
||||
</configuration>
|
||||
</plugin>
|
||||
|
||||
</plugins>
|
||||
</pluginManagement>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-checkstyle-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>io.spring.javaformat</groupId>
|
||||
<artifactId>spring-javaformat-maven-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>validate</phase>
|
||||
<inherited>true</inherited>
|
||||
<goals>
|
||||
<goal>validate</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>3.3.2</version>
|
||||
<configuration>
|
||||
<links>
|
||||
<link>https://docs.oracle.com/javase/8/docs/api/</link>
|
||||
<link>https://docs.oracle.com/javaee/8/api/</link>
|
||||
<link>https://fasterxml.github.io/jackson-core/javadoc/2.8/</link>
|
||||
<link>https://docs.spring.io/spring/docs/5.3.x/javadoc-api/</link>
|
||||
</links>
|
||||
<author>true</author>
|
||||
<header>${project.name}</header>
|
||||
<reportOutputDirectory>${project.build.directory}/site/${project.version}/apidocs</reportOutputDirectory>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
<reporting>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-checkstyle-plugin</artifactId>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</reporting>
|
||||
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>spring</id>
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>spring-snapshots</id>
|
||||
<name>Spring Snapshots</name>
|
||||
<url>https://repo.spring.io/libs-snapshot-local</url>
|
||||
<snapshots>
|
||||
<enabled>true</enabled>
|
||||
</snapshots>
|
||||
<releases>
|
||||
<enabled>false</enabled>
|
||||
</releases>
|
||||
</repository>
|
||||
<repository>
|
||||
<id>spring-milestones</id>
|
||||
<name>Spring Milestones</name>
|
||||
<url>https://repo.spring.io/libs-milestone-local</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
<repository>
|
||||
<id>spring-releases</id>
|
||||
<name>Spring Releases</name>
|
||||
<url>https://repo.spring.io/release</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
</repositories>
|
||||
<pluginRepositories>
|
||||
<pluginRepository>
|
||||
<id>spring-snapshots</id>
|
||||
<name>Spring Snapshots</name>
|
||||
<url>https://repo.spring.io/libs-snapshot-local</url>
|
||||
<snapshots>
|
||||
<enabled>true</enabled>
|
||||
</snapshots>
|
||||
<releases>
|
||||
<enabled>false</enabled>
|
||||
</releases>
|
||||
</pluginRepository>
|
||||
<pluginRepository>
|
||||
<id>spring-milestones</id>
|
||||
<name>Spring Milestones</name>
|
||||
<url>https://repo.spring.io/libs-milestone-local</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</pluginRepository>
|
||||
<pluginRepository>
|
||||
<id>spring-releases</id>
|
||||
<name>Spring Releases</name>
|
||||
<url>https://repo.spring.io/libs-release-local</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</pluginRepository>
|
||||
</pluginRepositories>
|
||||
</profile>
|
||||
|
||||
|
||||
</profiles>
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>spring-releases</id>
|
||||
<name>Spring Releases</name>
|
||||
<url>https://repo.spring.io/release</url>
|
||||
<snapshots>
|
||||
</snapshots>
|
||||
</repository>
|
||||
</repositories>
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>com.googlecode.maven-download-plugin</groupId>
|
||||
<artifactId>download-maven-plugin</artifactId>
|
||||
<version>1.6.8</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>unpack-doc-resources</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>wget</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<url>
|
||||
https://repo.spring.io/release/io/spring/docresources/spring-doc-resources/${spring-doc-resources.version}/spring-doc-resources-${spring-doc-resources.version}.zip
|
||||
</url>
|
||||
<unpack>true</unpack>
|
||||
<outputDirectory>${docs.build.directory}</outputDirectory>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-resources-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>copy-asciidoc-resources</id>
|
||||
<phase>generate-resources</phase>
|
||||
<goals>
|
||||
<goal>copy-resources</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<outputDirectory>${docs.build.directory}</outputDirectory>
|
||||
<resources>
|
||||
<resource>
|
||||
<directory>src/main/asciidoc</directory>
|
||||
</resource>
|
||||
</resources>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctor-maven-plugin</artifactId>
|
||||
<configuration>
|
||||
<sourceDirectory>${docs.build.directory}</sourceDirectory>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>generate-html-documentation</id>
|
||||
<phase>prepare-package</phase>
|
||||
<goals>
|
||||
<goal>process-asciidoc</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<backend>html5</backend>
|
||||
<doctype>book</doctype>
|
||||
<outputDirectory>${docs.output.directory}</outputDirectory>
|
||||
<attributes>
|
||||
// these attributes are required to use the doc resources
|
||||
<docinfo>shared</docinfo>
|
||||
<stylesdir>css/</stylesdir>
|
||||
<stylesheet>spring.css</stylesheet>
|
||||
<linkcss>true</linkcss>
|
||||
<icons>font</icons>
|
||||
<highlightjsdir>js/highlight</highlightjsdir>
|
||||
<highlightjs-theme>github</highlightjs-theme>
|
||||
<source-highlighter>highlight.js</source-highlighter>
|
||||
<project-version>${project.version}</project-version>
|
||||
</attributes>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
</project>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,9 @@
|
|||
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]\.'
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,73 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,270 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
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+'
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,120 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
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[—–]'
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
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}'
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
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'
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
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:
|
||||
- '\.\.\.'
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
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
|
||||
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
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)
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
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]'
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
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|$)'
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
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-'
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
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'
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
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+[.?!]'
|
||||
|
|
@ -0,0 +1,183 @@
|
|||
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
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
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'
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
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:
|
||||
- '["“][^"”“]+["”][.,]'
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
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'
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
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'
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
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'
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
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:
|
||||
- ';'
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
extends: occurrence
|
||||
message: "Try to keep sentences short (< 30 words)."
|
||||
scope: sentence
|
||||
level: suggestion
|
||||
max: 30
|
||||
token: \b(\w+)\b
|
||||
|
||||
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче