From feb1ed9e9fcd4f143a407c79be3e849652fb68e2 Mon Sep 17 00:00:00 2001 From: Veera Paananen Date: Tue, 3 Dec 2024 14:00:00 +0000 Subject: [PATCH 1/5] Remove hilla redirections by replacing old hilla.dev links with their new final URLs --- articles/advanced/modifying-the-bootstrap-page.asciidoc | 2 +- articles/configuration/pwa.asciidoc | 2 +- articles/security/enabling-security.adoc | 2 +- articles/upgrading/recommended-changes/index.adoc | 2 +- articles/upgrading/upgrade-tool/flow/_14-15.adoc | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/articles/advanced/modifying-the-bootstrap-page.asciidoc b/articles/advanced/modifying-the-bootstrap-page.asciidoc index d36b01bfbb..3778324896 100644 --- a/articles/advanced/modifying-the-bootstrap-page.asciidoc +++ b/articles/advanced/modifying-the-bootstrap-page.asciidoc @@ -86,7 +86,7 @@ const {serverSideRoutes} = new Flow({ }); const routes = [ - // for client-side, place routes below (more info https://hilla.dev/docs/routing) + // for client-side, place routes below (more info https://vaadin.com/docs/latest/hilla/guides/routing) // for server-side, the next magic line sends all unmatched routes: ...serverSideRoutes // IMPORTANT: this must be the last entry in the array diff --git a/articles/configuration/pwa.asciidoc b/articles/configuration/pwa.asciidoc index 6468e09974..f400e73256 100644 --- a/articles/configuration/pwa.asciidoc +++ b/articles/configuration/pwa.asciidoc @@ -12,7 +12,7 @@ They look like a regular application in the home screen of a mobile device or in A PWA needs some metadata, such as name, description, and icon, which are used by the operating system to display information about the application. To enable offline use, TypeScript needs to be used to provide the offline views. -https://hilla.dev[Hilla] is the recommended framework to build client-side views. +https://vaadin.com/hilla[Hilla] is the recommended framework to build client-side views. For a generic introduction to PWA, see the article on https://vaadin.com/pwa[What are Progressive Web Applications and Why Build a PWA]. diff --git a/articles/security/enabling-security.adoc b/articles/security/enabling-security.adoc index f0c7121a2f..44cfcd967b 100644 --- a/articles/security/enabling-security.adoc +++ b/articles/security/enabling-security.adoc @@ -293,7 +293,7 @@ The most important configuration in the above example is the call to [methodname This is how the view-based access control mechanism knows where to redirect users when they try to navigate to a protected view. The log-in view should always be accessible by anonymous users, so it should have the [annotationname]`@AnonymousAllowed` annotation. -This is especially important when using the variant of the [methodname]`setLoginView` method where you provide the route path (although this signature is meant to be used with https://hilla.dev[Hilla] views, not with Flow views). +This is especially important when using the variant of the [methodname]`setLoginView` method where you provide the route path (although this signature is meant to be used with https://vaadin.com/hilla[Hilla] views, not with Flow views). .Component-based security configuration diff --git a/articles/upgrading/recommended-changes/index.adoc b/articles/upgrading/recommended-changes/index.adoc index 0b8c051732..367c0d55c8 100644 --- a/articles/upgrading/recommended-changes/index.adoc +++ b/articles/upgrading/recommended-changes/index.adoc @@ -29,7 +29,7 @@ The reason for this API change is that, with client-side bootstrapping, the init - In Vaadin 10 to 14, these two steps are combined and the [filename]`index.html` page includes the code and configuration needed to start the Flow client engine and link the browser page to the server-side [classname]`UI` instance. - In Vaadin 15 and later, with client-side bootstrapping, the [filename]`index.html` page includes only the basic HTML markup and links to the TypeScript UI code. -If you have https://hilla.dev/docs/routing[client-side/Hilla views], the [classname]`UI` isn't guaranteed to be created, and so it's optional. +If you have https://vaadin.com/docs/latest/hilla/guides/routing[client-side/Hilla views], the [classname]`UI` isn't guaranteed to be created, and so it's optional. It's available only after the user navigates to a server-side route. It's also possible to continue using the bootstrapping mode in V10-14 with the `useDeprecatedV14Bootstrapping` flag. diff --git a/articles/upgrading/upgrade-tool/flow/_14-15.adoc b/articles/upgrading/upgrade-tool/flow/_14-15.adoc index ef71ce6644..e443f3bc61 100644 --- a/articles/upgrading/upgrade-tool/flow/_14-15.adoc +++ b/articles/upgrading/upgrade-tool/flow/_14-15.adoc @@ -43,7 +43,7 @@ The reason for this API change is that with client-side bootstrapping the initia - In Vaadin 10 to 14 these two steps are combined and the `index.html` page includes the code and configuration needed to start the Flow client engine and link the browser page to the server-side `UI` instance. -- In Vaadin 15+ with client-side bootstrapping the `index.html` page includes only the basic HTML markup and links to the TypeScript UI code. If you have https://hilla.dev/docs/routing[client-side/Hilla views], the `UI` isn't guaranteed to be created, thus is optional. It's only available after the user navigates to a server-side route. +- In Vaadin 15+ with client-side bootstrapping the `index.html` page includes only the basic HTML markup and links to the TypeScript UI code. If you have https://vaadin.com/docs/latest/hilla/guides/routing[client-side/Hilla views], the `UI` isn't guaranteed to be created, thus is optional. It's only available after the user navigates to a server-side route. It's also possible to continue using the bootstrapping mode in V10-14 with the `useDeprecatedV14Bootstrapping` flag. See how the use the flag in <<{articles}/configuration/properties#, Configuration Properties>>. From 205405f99bb5a716e97af8937a46a58ce926819e Mon Sep 17 00:00:00 2001 From: Veera Paananen Date: Tue, 3 Dec 2024 14:00:42 +0000 Subject: [PATCH 2/5] Update README by removing mentions of hilla.dev and the hilla branch --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 42e93a6b0c..49ff4d9330 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ Official documentation and code examples for Vaadin. -This repository does not generate the [vaadin.com/docs](https://vaadin.com/docs) or [hilla.dev/docs](https://hilla.dev/docs) websites. It only contains the content for them. The builds are done using [Vaadin Design System Publisher](https://vaadin.com/design-system-publisher). +This repository does not generate the [vaadin.com/docs](https://vaadin.com/docs) website. It only contains the content for it. The builds are done using [Vaadin Design System Publisher](https://vaadin.com/design-system-publisher). -The `latest` branch is for Vaadin documentation and selected by default. Select the `hilla` branch if you wish to contribute to Hilla documentation. +The `latest` branch is for Vaadin documentation and selected by default. ## Contents From 072e3bcb9a357318ae50401b729529f5514e336d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petter=20Holmstr=C3=B6m?= Date: Mon, 16 Dec 2024 13:13:31 +0200 Subject: [PATCH 3/5] Use same Vale workflow as latest --- .github/workflows/vale.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index bb1e930a3b..a1cd6fe439 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -5,6 +5,10 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 + - uses: ruby/setup-ruby@v1 + with: + ruby-version: 2.7 + - uses: reitzig/actions-asciidoctor@v2.0.2 - uses: errata-ai/vale-action@reviewdog with: files: articles From 0a0f0013c4c43857ffec2521ba54fb8a9ce69e31 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petter=20Holmstr=C3=B6m?= Date: Mon, 16 Dec 2024 13:18:39 +0200 Subject: [PATCH 4/5] Rename vocabs directory --- .github/styles/{Vocab => config/vocabularies}/Docs/accept.txt | 0 .github/styles/{Vocab => config/vocabularies}/Docs/reject.txt | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename .github/styles/{Vocab => config/vocabularies}/Docs/accept.txt (100%) rename .github/styles/{Vocab => config/vocabularies}/Docs/reject.txt (100%) diff --git a/.github/styles/Vocab/Docs/accept.txt b/.github/styles/config/vocabularies/Docs/accept.txt similarity index 100% rename from .github/styles/Vocab/Docs/accept.txt rename to .github/styles/config/vocabularies/Docs/accept.txt diff --git a/.github/styles/Vocab/Docs/reject.txt b/.github/styles/config/vocabularies/Docs/reject.txt similarity index 100% rename from .github/styles/Vocab/Docs/reject.txt rename to .github/styles/config/vocabularies/Docs/reject.txt From 5bbc31f2adac00c3284b0a9d992551c754eb8274 Mon Sep 17 00:00:00 2001 From: Veera Paananen Date: Thu, 19 Dec 2024 10:07:39 +0000 Subject: [PATCH 5/5] Remove links pointing to Hilla documentation (latest version) for now --- articles/advanced/modifying-the-bootstrap-page.asciidoc | 2 +- articles/configuration/pwa.asciidoc | 2 +- articles/security/enabling-security.adoc | 2 +- articles/upgrading/recommended-changes/index.adoc | 2 +- articles/upgrading/upgrade-tool/flow/_14-15.adoc | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/articles/advanced/modifying-the-bootstrap-page.asciidoc b/articles/advanced/modifying-the-bootstrap-page.asciidoc index 3778324896..2b471a26fa 100644 --- a/articles/advanced/modifying-the-bootstrap-page.asciidoc +++ b/articles/advanced/modifying-the-bootstrap-page.asciidoc @@ -86,7 +86,7 @@ const {serverSideRoutes} = new Flow({ }); const routes = [ - // for client-side, place routes below (more info https://vaadin.com/docs/latest/hilla/guides/routing) + // for client-side, place routes below // for server-side, the next magic line sends all unmatched routes: ...serverSideRoutes // IMPORTANT: this must be the last entry in the array diff --git a/articles/configuration/pwa.asciidoc b/articles/configuration/pwa.asciidoc index f400e73256..cc92084830 100644 --- a/articles/configuration/pwa.asciidoc +++ b/articles/configuration/pwa.asciidoc @@ -12,7 +12,7 @@ They look like a regular application in the home screen of a mobile device or in A PWA needs some metadata, such as name, description, and icon, which are used by the operating system to display information about the application. To enable offline use, TypeScript needs to be used to provide the offline views. -https://vaadin.com/hilla[Hilla] is the recommended framework to build client-side views. +Hilla is the recommended framework to build client-side views. For a generic introduction to PWA, see the article on https://vaadin.com/pwa[What are Progressive Web Applications and Why Build a PWA]. diff --git a/articles/security/enabling-security.adoc b/articles/security/enabling-security.adoc index 44cfcd967b..42d2809767 100644 --- a/articles/security/enabling-security.adoc +++ b/articles/security/enabling-security.adoc @@ -293,7 +293,7 @@ The most important configuration in the above example is the call to [methodname This is how the view-based access control mechanism knows where to redirect users when they try to navigate to a protected view. The log-in view should always be accessible by anonymous users, so it should have the [annotationname]`@AnonymousAllowed` annotation. -This is especially important when using the variant of the [methodname]`setLoginView` method where you provide the route path (although this signature is meant to be used with https://vaadin.com/hilla[Hilla] views, not with Flow views). +This is especially important when using the variant of the [methodname]`setLoginView` method where you provide the route path (although this signature is meant to be used with Hilla views, not with Flow views). .Component-based security configuration diff --git a/articles/upgrading/recommended-changes/index.adoc b/articles/upgrading/recommended-changes/index.adoc index 367c0d55c8..beb5b0df61 100644 --- a/articles/upgrading/recommended-changes/index.adoc +++ b/articles/upgrading/recommended-changes/index.adoc @@ -29,7 +29,7 @@ The reason for this API change is that, with client-side bootstrapping, the init - In Vaadin 10 to 14, these two steps are combined and the [filename]`index.html` page includes the code and configuration needed to start the Flow client engine and link the browser page to the server-side [classname]`UI` instance. - In Vaadin 15 and later, with client-side bootstrapping, the [filename]`index.html` page includes only the basic HTML markup and links to the TypeScript UI code. -If you have https://vaadin.com/docs/latest/hilla/guides/routing[client-side/Hilla views], the [classname]`UI` isn't guaranteed to be created, and so it's optional. +If you have Hilla views, the [classname]`UI` isn't guaranteed to be created, and so it's optional. It's available only after the user navigates to a server-side route. It's also possible to continue using the bootstrapping mode in V10-14 with the `useDeprecatedV14Bootstrapping` flag. diff --git a/articles/upgrading/upgrade-tool/flow/_14-15.adoc b/articles/upgrading/upgrade-tool/flow/_14-15.adoc index e443f3bc61..87579c1938 100644 --- a/articles/upgrading/upgrade-tool/flow/_14-15.adoc +++ b/articles/upgrading/upgrade-tool/flow/_14-15.adoc @@ -43,7 +43,7 @@ The reason for this API change is that with client-side bootstrapping the initia - In Vaadin 10 to 14 these two steps are combined and the `index.html` page includes the code and configuration needed to start the Flow client engine and link the browser page to the server-side `UI` instance. -- In Vaadin 15+ with client-side bootstrapping the `index.html` page includes only the basic HTML markup and links to the TypeScript UI code. If you have https://vaadin.com/docs/latest/hilla/guides/routing[client-side/Hilla views], the `UI` isn't guaranteed to be created, thus is optional. It's only available after the user navigates to a server-side route. +- In Vaadin 15+ with client-side bootstrapping the `index.html` page includes only the basic HTML markup and links to the TypeScript UI code. If you have Hilla views, the `UI` isn't guaranteed to be created, thus is optional. It's only available after the user navigates to a server-side route. It's also possible to continue using the bootstrapping mode in V10-14 with the `useDeprecatedV14Bootstrapping` flag. See how the use the flag in <<{articles}/configuration/properties#, Configuration Properties>>.