Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing Kubernetes Kit documentation error for V24 #3309

Open
wants to merge 38 commits into
base: latest
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
5484016
chore: Vale 3.0 config update (#3113)
jouni Jan 10, 2024
5a1f1b3
Adds devmode.hostsAllowed property (#3104)
tepi Jan 11, 2024
cead99f
docs: add instructions to disable component tracker (#3095)
mcollovati Jan 11, 2024
d077b74
fix: add note on DefaultI18NProvider available since 24.3 (#3112)
mcollovati Jan 11, 2024
48ac67c
Add navigation examples for hybrid apps (#3101)
mshabarov Jan 11, 2024
a27ab2e
docs: update data-provider article for item index provider (#3089)
tltv Jan 11, 2024
dde0497
Fix typo
tarekoraby Jan 11, 2024
986b04f
chore: update Gradle version
jouni Jan 12, 2024
cc1b2ee
fix: replace hardcoded links with cross references
jouni Jan 12, 2024
8085251
fix: vertical ellipsis → horizontal ellipsis
jouni Jan 12, 2024
a832dbd
fix: set i18n header before modifying for login java example (#5903) …
ugur-vaadin Jan 15, 2024
ea3e103
Update hardcoded vaadin version to 24.3.3 (#3141)
vaadin-bot Jan 16, 2024
fc4d821
Update vaadin version to 24.4.0.alpha1 (#3125)
vaadin-bot Jan 17, 2024
b77a760
fix: missing closing bracket
jouni Jan 18, 2024
4c8800c
docs: add note about AllowInert on RPC calls (#3111)
mcollovati Jan 29, 2024
ab55008
fix: broken include paths for some component descriptions
jouni Feb 6, 2024
41705e3
Update hardcoded vaadin version to 24.3.4 (#3182)
vaadin-bot Feb 12, 2024
cbcc41c
Update hardcoded vaadin version to 24.3.5 (#3189)
vaadin-bot Feb 13, 2024
82b612f
chore: Update a link to Add-on template project (#3192)
mshabarov Feb 14, 2024
b39b5c4
Add discussion id (#3181)
samie Feb 14, 2024
27844c8
docs: Write as draft; Bypassing validators (CP: latest) (#3208)
tepi Feb 23, 2024
ce3c682
docs: ViewAccessChecker has been replaced by NavigationAccessControl …
chkpnt Feb 29, 2024
5cd1410
Update hardcoded vaadin version to 24.3.6 (#3253)
vaadin-bot Mar 4, 2024
cba0c8d
Update hardcoded vaadin version to 24.3.7 (#3284)
vaadin-bot Mar 13, 2024
3a00f66
Update vaadin version to 24.3.7 (#3283)
vaadin-bot Mar 13, 2024
b635d76
Remove duplicated text (#3302)
bwajtr Mar 21, 2024
bdee2eb
Update hardcoded vaadin version to 24.3.8 (#3306)
vaadin-bot Mar 25, 2024
34e6835
Update vaadin version to 24.3.8 (#3305)
vaadin-bot Mar 25, 2024
b7afb7b
chore: escape asterisk (#3292)
oliveryasuna Mar 25, 2024
e4516e5
Fixing documentation error for V24
rodolforfq Mar 25, 2024
977d04c
Fixed yaml config example
rodolforfq Mar 25, 2024
231ed79
docs: Use Gradle toolchain to specify Java version in upgrade guide (…
chkpnt Mar 26, 2024
178b654
Update hardcoded vaadin version to 24.3.9 (#3318)
vaadin-bot Apr 3, 2024
3e5b516
Update vaadin version to 24.3.9 (#3317)
vaadin-bot Apr 3, 2024
b6f6a36
Merge branch 'latest' into k8s-kit-doc-fix-v24
russelljtdyer Apr 8, 2024
a418d35
docs: update references to allowed and blocked packages (#3191) (#3327)
mcollovati Apr 8, 2024
586af1f
fix: fix interface name in navigation docs (CP: latest) (#3319)
mcollovati Apr 8, 2024
fa1c06b
Merge branch 'latest' into k8s-kit-doc-fix-v24
rodolforfq Apr 18, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions articles/_vaadin-version.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
:vaadin-version: 24.3.2
:vaadin-flow-version: 24.3.2
:vaadin-version: 24.3.9
:vaadin-flow-version: 24.3.8
:vaadin-seven-version: 7.7.38
:vaadin-eight-version: 8.20.0
6 changes: 5 additions & 1 deletion articles/advanced/i18n-localization.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,18 @@ description: Implementing localization and translation strings using I18NProvide
order: 20
---

= [since:com.vaadin:vaadin@V24.3]#Localization#

= Localization

To use localization and translation strings, the application needs only to have the translation properties available on the classpath under the directory, `vaadin-i18n` with the filename prefix, `translations` (e.g., `src/main/resources/vaadin-i18n/translations.properties`).

When using localization in an application, calling for a translation, or when the I18NProvider is used for the first time, the folder resource, `vaadin-i18n` is checked if it contains any `translations.properties` or `translations_[langcode].properties` files. Any language codes are collected from the available property files and added as provided locales in the [classname]`DefaultI18NProvider`.

The file `translations.properties` is a default translation file that'll be used for any [classname]`Locale` that doesn't have a specific translations file. Locale translation files are named, for example, like [filename]`translations_fi_FI.properties` or [filename]`translations_de.properties`. The automatic [classname]`Locale` creation supports from one to three parts (e.g., `translations_language_country_variant.properties`).

[NOTE]
[classname]`DefaultI18NProvider` is available as of version 24.3 of Vaadin Flow. For an earlier version, you'll need to implement your own [interfacename]`I18NProvider`, as documented in <<#defining-i18n-provider-property,Defining I18n Provider Property>> section.


== Locale Selection for New Session

Expand Down
14 changes: 14 additions & 0 deletions articles/binding-data/components-binder-load.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,20 @@ If a bean-level validator fails in [methodname]`writeBean(Object)` or [methodnam
Remember to check your `getters/setters` to ensure there are no unwanted side effects.


== Writing as a Draft

In addition to other means of writing field values to a business object, there's also a way to write the bean as a draft. This means that it's not required for all field validations to pass, and bean-level validation isn't run at all.

[source,java]
----
// This will write all values which pass conversion and field-level validation to person bean.
binder.writeBeanAsDraft(person);

// This will write all values which pass conversion to person bean, ignoring field-level validation.
binder.writeBeanAsDraft(person, true);
----


== Tracking Binding Status

[classname]`Binder` keeps track of which bindings have been updated by the user and which bindings are in an invalid state.
Expand Down
15 changes: 14 additions & 1 deletion articles/binding-data/components-binder-validation.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,23 @@ departing.addValueChangeListener(
event -> returningBinding.validate());
----


=== Temporarily By-Passing Validation

Validators can be by-passed temporarily on both binder-level and binding-level. In practice, this allows bean writing to succeed even when one or more validators would not pass.

[source,java]
----
// Disables all validators, both binder-level and binding-level
binder.setValidatorsDisabled(true);

// Disables validators for a single binding
binding.setValidatorsDisabled(true);
----

== Converting User Input

You can bind application data to a UI field component, even if the types don't match.

Examples where this is useful include:

* an application-specific type for a postal code that the user enters in a `TextField`;
Expand Down

Large diffs are not rendered by default.

7 changes: 5 additions & 2 deletions articles/compatibility.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This page shows the minimum required versions of supported technologies for Vaad
| Spring Boot| 3.0 or later
| Node.js| 18 or later
| Maven| 3.5 or later (except for 3.8.2 and 3.8.3)
| Gradle| 7.5 or later
| Gradle| 8.5 or later
| Servlet| 6 or later
| Application Servers
a|
Expand Down Expand Up @@ -61,8 +61,11 @@ Vaadin 24 is supported by several web browsers. The following is a list of compa
| Safari | 15 or later
|===


[discussion-id]`06849B4A-676D-49C6-BED2-290DD90DF57D`

++++
<style>
[class^=PageHeader-module--descriptionContainer] {display: none;}
</style>
++++
++++
6 changes: 3 additions & 3 deletions articles/components/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ include::message-input/index.asciidoc[tag=description]

image::{components-path-prefix}multi-select-combo-box/multi-select-combo-box.png["", role="banner"]

include::multi-select-combo-box/index.asciidoc[tag=description]
include::multi-select-combo-box/index.adoc[tag=description]

[.sr-only]
<<{components-path-prefix}multi-select-combo-box#,See Multi-Select Combo Box>>
Expand Down Expand Up @@ -466,7 +466,7 @@ endif::[]

image::{components-path-prefix}menu-bar/menu-bar.png["", opts=inline, role="banner"]

include::menu-bar/index.asciidoc[tag=description]
include::menu-bar/index.adoc[tag=description]

[.sr-only]
<<{components-path-prefix}menu-bar#,See Menu Bar>>
Expand All @@ -477,7 +477,7 @@ include::menu-bar/index.asciidoc[tag=description]

image::{components-path-prefix}message-list/message-list.png["", role="banner"]

include::message-list/index.asciidoc[tag=description]
include::message-list/index.adoc[tag=description]


[.sr-only]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: Component Locator
description: Use Component Locator to identify components in views and find their source code in your IDE.
description: Use Component Locator to identify components in views and find their source code in an IDE.
order: 1
---


= [since:com.vaadin:vaadin@V24]#Component Locator#

You can use the component locator to identify components and to find their code when running applications in <<../#,development mode>>. The component locator opens the corresponding source code in your IDE when you click a component (for example, a Button in a view).
You can use the component locator to identify components, and to find their code when running applications in <<../#,development mode>>. The component locator opens the corresponding source code in your IDE when you click a component (e.g., a Button in a view).


== Enabling Component Locator

Start by running your Vaadin application project in development mode. Click on the Vaadin symbol [guilabel]*}>* at the bottom right-hand corner of your browser window -- as indicated in the screenshot here.
Start by running your Vaadin Flow application project in development mode. Click on the Vaadin symbol [guilabel]*}>* at the bottom right-hand corner of your browser window -- as indicated in the screenshot here.

[.device]
image::/images/dev-tools-location.png[The Vaadin symbol location in development mode.]
Expand All @@ -25,7 +25,7 @@ image::/images/code-menu.png[The Code tab viewed in the Dev tools menu.]

== Using Component Locator

Now that the Component Locator has been enabled, you're ready to use it. To highlight a component in red and identify it, hover your pointer over one in the view. The component names appear in a list at the bottom right-hand corner of your browser window. You can use the arrow keys to navigate that list.
Now that the Component Locator has been enabled, it's ready to be used. To highlight a component in red and identify it, hover your pointer over one in the view. The component names appear in a list at the bottom right-hand corner of your browser window. You can use the arrow keys to navigate that list.

[.device]
image::/images/component-locator.png[Component Locator highlighting and identifying the Button component.]
Expand All @@ -39,3 +39,17 @@ image::/images/code-view.png[The Button component and corresponding source code.
[class^=PageHeader-module--descriptionContainer] {display: none;}
</style>
++++


[since:com.vaadin:vaadin@V24.4]
== Disable Component Tracking

Component tracking isn't an expensive operation, but it may at times be useful to disable it. Be aware that with component tracking disabled, the Component Locator tool cannot identify any components. To disable tracking, set the `vaadin.devmode.componentTracker.enabled` configuration parameter to `false`.
See <<{articles}/configuration/properties#,Configuration Properties>> for more information about setting configuration parameters.


++++
<style>
[class^=PageHeader-module--descriptionContainer] {display: none;}
</style>
++++
7 changes: 6 additions & 1 deletion articles/configuration/development-mode/dev-tools/index.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Development Tools
description: Vaadin tools that are available when running applications in development mode.
description: Vaadin tools available when running applications in development mode.
order: 209
---

Expand All @@ -9,6 +9,11 @@ order: 209

Boost productivity with the Vaadin Development Tools, such as Component Locator, that are available when running applications in development mode.

Current and future functionality of Vaadin Development Tools may offer developers ways to alter the application configuration or even application code. Therefore, it may not be desirable to enable access to Development Tools for everyone -- even when running an application in development mode.

By default, Development Tools can be accessed only from loopback addresses. To configure hosts for Development Tools access, please see `devmode.hostsAllowed` <<{articles}/configuration/properties/#properties,configuration property>>.


== Topics

section_outline::[]
Expand Down
11 changes: 9 additions & 2 deletions articles/configuration/properties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ order: 10

= Configuration Properties

You can change the behavior of Vaadin applications by setting the configuration properties. You can use either system properties, or servlet initialization parameters to set them. See the <<properties,full list of properties>> for details.
You can change the behavior of Vaadin applications by setting the configuration properties. You can set them either through the system properties, or the servlet initialization parameters. See the <<properties,full list of properties>> for details.

See also the <<{articles}/integrations/spring/configuration#, Spring-specific instructions>> for Spring-based applications.

Expand Down Expand Up @@ -96,7 +96,6 @@ When a system property and a servlet parameter have the same name, the system pr

The following table contains the properties that are defined in the [classname]`com.vaadin.server.DeploymentConfiguration` and [classname]`com.vaadin.server.Constants` classes. They're listed in alphabetical order. If you use Spring Boot, you should add the `vaadin.` prefix to them (e.g., change `brotli` to `vaadin.brotli`).


[cols="1,1,4"]
|===
|Property Name |Default Value |Description
Expand All @@ -109,6 +108,10 @@ The following table contains the properties that are defined in the [classname]`
|`false`
|Closes the Vaadin session if no UI is active. A UI is considered active if it's open on the client-side and has any activity -- besides heartbeat requests. By default, heartbeat requests keep the Vaadin session open even when there is no user interaction. Set to `true` to close idle sessions. See `heartbeatInterval` below.

|`devmode.hostsAllowed`
|`null`
|Defines the hosts allowed to access Vaadin development tools. A comma-separated list of allowed hosts should be provided as the value. The `?` and `\*` wildcards can be used (e.g., `192.168.1.*,172.17.?.*`). Loopback addresses are always allowed, regardless of the value set here.

|`devmode.liveReload.enabled`
|`true`
|Enables live reload. When using a server-side <<live-reload/index#, live reload tool>>, the browser is refreshed after code is rebuilt on the server. Set to `false` to disable automatic reloading of the browser. This applies only to development mode.
Expand All @@ -121,6 +124,10 @@ The following table contains the properties that are defined in the [classname]`
|`false`
|Enables session serialization. When session serialization is enabled, [classname]`UI` instances and registered [classname]`StreamResource` instances are serialized or deserialized when restarting the development server. When set to `true`, for example, access control information can be preserved during development so that you don't need to log in for each change. This applies only to development mode.

|`devmode.componentTracker.enabled`
|`true`
|Enables the <<development-mode/dev-tools/component-locator#, Component Locator>> tracker utility. Set to `false` to disable. With it disabled, the Component Locator tool cannot identify any components. This applies only to development mode.

|`devmode.usageStatistics.enabled`
|`true`
|Enables Vaadin to collect usage statistics that can guide further development. Statistics are collected based on features that are used in the application. No data is collected in production mode. Some usage statistics are collected through the web browser. See the https://github.com/vaadin/vaadin-usage-statistics[client-side collector repository] for instructions on how to opt out. This applies only to development mode.
Expand Down
5 changes: 4 additions & 1 deletion articles/contributing/docs/styleguide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ Avoid ending a sentence with an exclamation mark. Its use in normal text is dist

Don't pose a question in the text; don't end a sentence with a question mark. You're not in dialog with the reader, so don't ask them a question when you can't hear their response. That's potentially irritating to the reader. Instead, write what you want to say without questions. The exception to posing a question and using a question mark is for titles of troubleshooting articles.

The use of ellipses (i.e., &vellip;) at the end of a sentence, usually an incomplete sentence, is meant to indicate that the writer is thinking or calling upon the reader to ponder something. Write complete sentences; write what you want to say. Don't require the reader to wonder what you're thinking. Ellipses sometimes can be used in the same way in the middle of a sentence. They're also sometimes used in lieu of etc. Again, don't use them.
The use of ellipses (i.e., &hellip;) at the end of a sentence, usually an incomplete sentence, is meant to indicate that the writer is thinking or calling upon the reader to ponder something. Write complete sentences; write what you want to say. Don't require the reader to wonder what you're thinking. Ellipses sometimes can be used in the same way in the middle of a sentence. They're also sometimes used in lieu of etc. Again, don't use them.

These three punctuation rules don't apply to using them as part of some code syntax or code example. They apply only to sentences and headings. Ellipses are sometimes used in code or log examples in place of lengthy, unimportant text. This is an acceptable use.

Expand Down Expand Up @@ -492,6 +492,9 @@ Call `setEnabled(false)` to disable it.
// TODO source-code



[discussion-id]`FAAF4D05-ED0A-4D13-A416-C8033BACC6A3`

++++
<style>
[class^=PageHeader-module--descriptionContainer] {display: none;}
Expand Down
2 changes: 2 additions & 0 deletions articles/contributing/docs/vale.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ pass:[<!-- vale Vaadin.Will = YES -->]
Rules that use `scope: raw` (e.g., `Vaadin.SourceCode`) can't be suppressed with these comments.


[discussion-id]`B8CB88DA-F241-4F01-BEDE-22C4AEA6F4AC`

++++
<style>
[class^=PageHeader-module--descriptionContainer] {display: none;}
Expand Down
3 changes: 3 additions & 0 deletions articles/contributing/pr.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,9 @@ If the PR isn't approved by the reviewer and there is no response from the autho

Another aspect to consider is that, as time passes, more and more new features and fixes are merged into the `main` branch. As a result, the more a PR is waiting to be merged, the higher the probability of merge conflicts. Such conflicts must be resolved before the merge.


[discussion-id]`72291A8F-D77D-4730-B035-7D548AF8DA4D`

++++
<style>
[class^=PageHeader-module--descriptionContainer] {display: none;}
Expand Down
4 changes: 3 additions & 1 deletion articles/contributing/tests.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -313,8 +313,10 @@ If possible, avoid asynchronous tests. It simplifies reviewing of the test and h
Keep in mind that there could be differences in browsers behaviour, so it's a good habit to check that tests pass on all supported browsers. Supported browsers are listed in the release notes of each Vaadin major and minor release: https://github.com/vaadin/platform/releases


[discussion-id]`77BC1B54-F570-41CD-96A5-4DC80E437C83`

++++
<style>
[class^=PageHeader-module--descriptionContainer] {display: none;}
</style>
++++
++++
Loading
Loading