Minor Clean-Up: testing to upgrading (#2732)

Co-authored-by: Jouni Koivuviita <jouni@vaadin.com>

Author: russelljtdyer

.github/styles/Vaadin/Abbr.yml

@@ -54,6 +54,7 @@ exceptions:
   - MDN
   - MIME
   - MPR
+  - MVC
   - OCR
   - PATH
   - PDF

.github/styles/Vaadin/So.yml

@@ -1,6 +1,7 @@
-extends: existence
-message: "Don't start a sentence with '%s'."
+extends: substitution
+message: "Don't start a sentence with 'So'."
 level: warning
 scope: sentence
-raw:
-  - '(?:[;-]\s)so[\s,]|\bSo[\s,]'
+swap:
+  # Allow 'So far'
+  '(?:[;-]\s)so[\s,]\W|\bSo,?\s?\w+': 'So far'

.github/styles/Vaadin/Terms.yml

@@ -25,7 +25,7 @@ swap:
   'front-end(?! code| dependency| dependencies| development| developers?| teams?| sources?| resources?| files?| build| states?| tests?| testing| servers?| proxy| proxies| changes?| bundle| reloading| directory| directories| packages?| modules?| installation| customizations?| re-customizations?| compilation| services?| logic| applications?| traces?| spans?| endpoints?| tools?)': frontend
   grayed-out: unavailable
   NPM: npm
-  open-source: open source
+  # open-source: open source
   regex: regular expression
   repo: repository
   timeframe: time frame

articles/api.adoc

@@ -1,65 +1,71 @@
 ---
 title: API Reference
+description: Links to Application Programming Interface documentation.
 order: 999
 layout: index
 ---
 
+
 = API Reference
 :toclevels: 2
 
 The Application Programming Interface (API) documentation for all Java classes and interfaces.
 
 link:http://vaadin.com/api/platform/{moduleMavenVersion:com.vaadin:vaadin}/index.html[Javadoc, role="button primary water"]
 
+
 == Shortcuts
 
 Below are shortcuts to certain parts of the API documentation.
 
 
-
 [.cards.quiet]
 === Flow
 
+
 [.card]
 ==== Binder
 link:http://vaadin.com/api/platform/{moduleMavenVersion:com.vaadin:vaadin}/com/vaadin/flow/data/binder/package-summary.html[`com.vaadin.flow.data.binder`]
 
+
 [.card]
 ==== DataProvider
 link:http://vaadin.com/api/platform/{moduleMavenVersion:com.vaadin:vaadin}/com/vaadin/flow/data/provider/package-summary.html[`com.vaadin.flow.data.provider`]
 
+
 [.card]
 ==== Router
 link:http://vaadin.com/api/platform/{moduleMavenVersion:com.vaadin:vaadin}/com/vaadin/flow/router/package-summary.html[`com.vaadin.flow.router`]
 
 
-
 [.cards.quiet]
 === Design System
 
+
 [.card]
 ==== Components
 Links to component API docs are under the "API" page for each component.
 xref:{articles}/components#[Browse components]
 
 
-
 [.cards.quiet]
 === Collaboration Kit
 
+
 [.card]
 ==== Core API
 link:http://vaadin.com/api/platform/{moduleMavenVersion:com.vaadin:vaadin}/com/vaadin/collaborationengine/package-summary.html[`com.vaadin.collaborationengine`]
 
 
-
 [.cards.quiet]
 === TestBench
 
+
 [.card]
 ==== Core API
 link:http://vaadin.com/api/com.vaadin/vaadin-testbench-core/[`com.vaadin.testbench`]
 
+
 [.card]
 ==== Component API
 link:http://vaadin.com/api/com.vaadin/vaadin-components-testbench/[`com.vaadin.flow.component.*.testbench`]

articles/compatibility.adoc

@@ -7,9 +7,7 @@ order: 901
 
 = List of Supported Technologies
 
-This page shows the minimum required versions of supported technologies for *Vaadin 24*. See the http://github.com/vaadin/platform/releases/tag/24.0.0[release notes] for more details.
-
-pass:[<!-- vale Vaadin.Abbr = NO -->]
+This page shows the minimum required versions of supported technologies for Vaadin 24. See the http://github.com/vaadin/platform/releases/tag/24.0.0[release notes] for more details.
 
 [cols="1,1"]
 |===
@@ -21,16 +19,16 @@ pass:[<!-- vale Vaadin.Abbr = NO -->]
 | Maven| 3.5 or later (except for 3.8.2 and 3.8.3)
 | Gradle| 7.5 or later
 | Servlet| 6 or later
-| Application servers
-a| 
-
-* Apache Tomcat 10.1
-* Open Liberty 23.0.0.1-beta
-* RedHat JBoss EAP 8.0 beta
-* WildFly 27
-* Jetty 11
-* Payara Server 6
-* Payara Micro 6
+| Application Servers
+a|
+
+- Apache Tomcat 10.1
+- Open Liberty 23.0.0.1-beta
+- RedHat JBoss Enterprise Application Platform (EAP) 8.0 beta
+- WildFly 27
+- Jetty 11
+- Payara Server 6
+- Payara Micro 6
 | Portlet| Not supported yet
 | OSGi| Not supported yet
 | Karaf| Not supported yet
@@ -62,5 +60,3 @@ Vaadin 24 is supported by several web browsers. The following is a list of compa
 | Chrome | Evergreen
 | Safari | 15 or later
 |===
-
-pass:[<!-- vale Vaadin.Abbr = YES -->]

articles/components/charts/migrating-from-earlier-versions.asciidoc

@@ -74,7 +74,7 @@ See the <<css-styling#,CSS Styling guide>> for detailed instructions.
 
 === Running Charts 9 in Vaadin 14
 
-Although Charts 9 was released in a later Vaadin version, you can use it in a Vaadin 14 project in *npm mode* by overriding the version number in the `pom.xml` file:
+Although Charts 9 was released in a later Vaadin version, you can use it in a Vaadin 14 project in *npm mode* by overriding the version number in the [filename]`pom.xml` file:
 
 .pom.xml
 [source,xml]

articles/components/charts/svg-generator.asciidoc

@@ -11,7 +11,7 @@ This allows you to generate an SVG string of any chart, using a [classname]`Conf
 
 == Installing
 
-Add the `vaadin-charts-flow-svg-generator` dependency to your project's `pom.xml` as follows:
+Add the `vaadin-charts-flow-svg-generator` dependency to your project's [filename]`pom.xml` as follows:
 
 [source,xml]
 ----

articles/styling/advanced/multi-app-themes.adoc

@@ -22,7 +22,7 @@ An <<../application-theme#, application theme>> can be used in multiple applicat
 └── pom.xml
 ----
 
-2: Update `pom.xml` as follows:
+2: Update [filename]`pom.xml` as follows:
 
 . Configure the theme library's identifiers and packaging format.
 . Configure the Vaadin platform version.
@@ -98,7 +98,7 @@ See Vaadin's <<{articles}/integrations/spring/configuration#special-configuratio
 
 4: Create the JAR file by running the command `mvn install` in the project root folder. The file will be generated in the `target` sub-folder.
 
-To use the packaged theme in an application, add the JAR as a dependency in the application project's `pom.xml`, and apply the theme either using the <<../application-theme#applying-a-theme, @Theme annotation>>, or in `theme.json` as a <<parent-and-sub-themes#, parent-theme>> to the application's own theme.
+To use the packaged theme in an application, add the JAR as a dependency in the application project's [filename]`pom.xml`, and apply the theme either using the <<../application-theme#applying-a-theme, @Theme annotation>>, or in `theme.json` as a <<parent-and-sub-themes#, parent-theme>> to the application's own theme.
 
 .Application project pom.xml
 [source,xml]

articles/testing/end-to-end/advanced-concepts.adoc

@@ -1,14 +1,17 @@
 ---
-title: Advanced Testing Methods 
+title: Advanced Testing Methods
+description: Describes advanced methods for testing a project.
 order: 80
 ---
 
+
 = Advanced Testing Methods
 
 There are a few advanced testing methods you may want to consider: waiting for Vaadin; waiting until a particular condition is met; scrolling; profiling test execution time; and running tests in parallel.
 
 These testing methods aren't typically needed. For example, situations in which you might need to disable automatic waiting or scrolling in a view are rare. In such cases, you've probably encountered a bug in the software. Nevertheless, these testing methods are explained here for when they are needed.
 
+
 == Waiting for Vaadin
 
 Web pages are typically loaded and rendered immediately by the browser. In such applications, you can test the page elements immediately after the page is loaded. In Vaadin and other Single-Page Applications (SPAs), rendering is done by JavaScript code, asynchronously. Therefore, you need to wait until the server has given its response to an AJAX request and the JavaScript code finishes rendering the UI.
@@ -33,7 +36,7 @@ testBench(driver).waitForVaadin();
 You can re-enable waiting in the same interface with [methodname]`enableWaitForVaadin()`.
 
 
-== Waiting Until a Condition is Met
+== Waiting for Condition's Met
 
 In addition to waiting for Vaadin, it's also possible to wait until a condition is met. For example, you might want to wait until an element is visible on the web page. That might be done like so:
 
@@ -65,7 +68,6 @@ Furthermore, in Vaadin applications there are two sides which need to be profile
 The `TestBenchCommands` interface offers the following methods for profiling test execution time:
 
 [methodname]`totalTimeSpentServicingRequests()`:: This returns the total time in milliseconds spent servicing requests in the application on the server side. The timer starts when you first navigate to the application and hence start a new session. The time passes only when servicing requests for the particular session.
-
 +
 If you're also interested in the client-side performance for the last request, you must call [methodname]`timeSpentRenderingLastRequest()` before calling this method. It's necessary because this method makes an extra server request, which causes an empty response to be rendered.
 
@@ -83,7 +85,6 @@ If you also call [methodname]`timeSpentServicingLastRequest()` or [methodname]`t
 
 The following example is given in the `link:http://github.com/vaadin/testbench-demo/blob/master/src/test/java/com/vaadin/testbenchexample/VerifyExecutionTimeITCase.java[VerifyExecutionTimeITCase.java]` file in the TestBench demo:
 
-
 [source,java]
 ----
 @Test
@@ -128,6 +129,7 @@ public void verifyServerExecutionTime() throws Exception {
 }
 ----
 
+
 == Running Tests in Parallel
 
 TestBench supports parallel tests execution using its own test runner (JUnit 4) or native link:http://junit.org/junit5/docs/current/user-guide/#writing-tests-parallel-execution[JUnit 5 parallel execution].
@@ -145,12 +147,14 @@ If your tests don't work in parallel, set the `com.vaadin.testbench.Parameters.t
 
 [role="since:com.vaadin:vaadin@V24"]
 
+
 === Using Native JUnit 5 Parallel Execution
 
 To run tests in parallel, extend the TestBench utility class `BrowserTestBase` or manually annotate test classes with `@Execution(ExecutionMode.CONCURRENT)`.
 
 To disable parallel execution, annotate the test class with `@Execution(ExecutionMode.SAME_THREAD)`.
 
+
 === Accessing WebDriver and Additional Test Information
 
 Using JUnit 5, it is possible to access additional test information in a method annotated with `@Test`, `@BeforeEach`, `@AfterEach`, `@BeforeAll`, or `@AfterAll` by adding the `BrowserTestInfo` method parameter. Here is an example of this:

articles/testing/end-to-end/bdd.adoc

@@ -1,8 +1,10 @@
 ---
 title: Behavior-Driven Development
+description: A method of developing software starting with writing tests in plain spoken language.
 order: 100
 ---
 
+
 = Behavior-Driven Development
 
 Behavior-Driven Development (BDD) is a development methodology based on test-driven development, where development starts from writing tests for the software-to-be. BDD involves using a _ubiquitous language_ to communicate between business goals (i.e., the desired behavior) and tests to ensure that the software fulfills those goals.
@@ -13,15 +15,14 @@ Stories can be expressed as number of _scenarios_ that describe different cases
 
 pass:[<!-- vale Vaadin.FirstPerson = NO -->]
 
-* _Given_ that I have calculator open,
+- _Given_ that I have calculator open,
 
-* _When_ I push calculator buttons,
+- _When_ I push calculator buttons,
 
-* _Then_ the display should show the result.
+- _Then_ the display should show the result.
 
 pass:[<!-- vale Vaadin.FirstPerson = YES -->]
 
-
 This kind of formalization is realized in the JBehave BDD framework for Java. The TestBench Demo includes a JBehave example, where the above scenario is written as the link:http://github.com/vaadin/testbench-demo/blob/master/src/test/java/com/vaadin/testbenchexample/bdd/CalculatorSteps.java[following test class]:
 
 [.example]