search

vaadin / docs

Official documentation for Vaadin and Hilla.
https://vaadin.com/docs
Other
29 stars 190 forks source link

Broken cross references (links) #87

Closed jouni closed 3 years ago

jouni commented 3 years ago

Use absolute references

When fixing the references, use the {articles} attribute as a prefix when linking across top-level sections (between Flow, Fusion, Design System, etc), to make the references more future-proof (they won’t break if the article hierarchy is modified).

For example: <<{articles}/guide/overview#, Beginner's Guide>>

warn Broken cross reference ../guide/production/production-overview in ce/going-to-production.asciidoc
warn Broken cross reference ../guide/production/mode in ce/going-to-production.asciidoc
warn Broken cross reference ../flow/advanced/flow-runtime-configuration in ce/going-to-production.asciidoc
warn Broken internal reference css-styling in ds/components/charts/java-api/migrating-from-earlier-versions.asciidoc
warn Broken cross reference ../treegrid in ds/components/grid-pro/index.asciidoc
warn Broken cross reference ../check-box in ds/components/radio-button/index.asciidoc
warn Broken cross reference ../ordered-layout in ds/components/scroller/index.asciidoc
warn Broken cross reference ../ordered-layout in ds/components/scroller/index.asciidoc
warn Broken cross reference flow-runtime-configuration in flow/advanced/application-lifecycle.asciidoc
warn Broken cross reference ../typescript/starting-the-app in flow/advanced/service-init-listener.asciidoc
warn Broken cross reference starting-the-app in flow/advanced/modifying-the-bootstrap-page.asciidoc
warn Broken internal reference loading-resources/<mark>importing-javascript-and-css in flow/advanced/dependency-filter.asciidoc
warn Broken internal reference styling/importing-style-sheets</mark> in flow/advanced/dependency-filter.asciidoc
warn Broken cross reference ways-of-importing in flow/advanced/css-loading-order.asciidoc
warn Broken cross reference component-integration in flow/application/templates.asciidoc
warn Broken cross reference ../../theming/overview in flow/components/overview.asciidoc
warn Broken cross reference ../../theming/styling-components in flow/components/grid.asciidoc
warn Broken cross reference component-basic in flow/creating-components/overview.asciidoc
warn Broken cross reference component-many-elements in flow/creating-components/overview.asciidoc
warn Broken cross reference component-composite in flow/creating-components/overview.asciidoc
warn Broken cross reference component-container in flow/creating-components/overview.asciidoc
warn Broken cross reference component-property-descriptor in flow/creating-components/overview.asciidoc
warn Broken cross reference component-events in flow/creating-components/overview.asciidoc
warn Broken cross reference component-lifecycle-callbacks in flow/creating-components/overview.asciidoc
warn Broken cross reference component-mixins in flow/creating-components/overview.asciidoc
warn Broken cross reference ../../theming/styling-components in flow/creating-components/extending-component.asciidoc
warn Broken internal reference drag-source in flow/dnd/drop-target.asciidoc
warn Broken cross reference ../../advanced/flow-runtime-configuration in flow/integrations/cdi/overview.asciidoc
warn Broken cross reference ../spring/spring-scopes in flow/integrations/cdi/contexts.asciidoc
warn Broken cross reference ../../advanced/push-access in flow/integrations/cdi/contexts.asciidoc
warn Broken cross reference ../../routing/annotation in flow/integrations/cdi/contexts.asciidoc
warn Broken cross reference ../routing/router-layout in flow/integrations/cdi/contexts.asciidoc
warn Broken cross reference basic in flow/integrations/spring/spring-mvc.asciidoc
warn Broken cross reference spring-scopes in flow/integrations/spring/spring-mvc.asciidoc
warn Broken cross reference basic in flow/integrations/spring/spring-mvc.asciidoc
warn Broken cross reference ../../routing/annotation in flow/integrations/embedding/limitations.asciidoc
warn Broken cross reference ../../routing/annotation in flow/integrations/embedding/limitations.asciidoc
warn Broken cross reference webcomponent-push in flow/integrations/embedding/limitations.asciidoc
warn Broken cross reference webcomponent-intro in flow/integrations/embedding/limitations.asciidoc
warn Broken cross reference ../../routing/annotation in flow/integrations/spring/routing.asciidoc
warn Broken cross reference basic in flow/integrations/spring/routing.asciidoc
warn Broken cross reference spring-basic-mvc in flow/integrations/spring/routing.asciidoc
warn Broken cross reference ../../routing/annotation in flow/integrations/spring/routing.asciidoc
warn Broken cross reference basic in flow/integrations/spring/routing.asciidoc
warn Broken cross reference spring-basic-mvc in flow/integrations/spring/routing.asciidoc
warn Broken cross reference basic-mvc in flow/integrations/spring/configuration.asciidoc
warn Broken cross reference ../../guide/production/production-mode-basic in flow/integrations/osgi-basic.asciidoc
warn Broken cross reference ../routing/routing-annotation in flow/integrations/osgi-basic.asciidoc
warn Broken cross reference ../routing/routing-exception-handling in flow/integrations/osgi-basic.asciidoc
warn Broken cross reference ../pwa/pwa-pwa-with-flow in flow/integrations/osgi-basic.asciidoc
warn Broken cross reference spring/basic in flow/integrations/overview.asciidoc
warn Broken cross reference cdi/basic in flow/integrations/overview.asciidoc
warn Broken cross reference embedding/intro in flow/integrations/overview.asciidoc
warn Broken cross reference integrations/osgi-basic in flow/integrations/overview.asciidoc
warn Broken cross reference integrations/osgi-karaf in flow/integrations/overview.asciidoc
warn Broken cross reference security-intro in flow/security/overview.asciidoc
warn Broken cross reference security-vulnerabilities in flow/security/overview.asciidoc
warn Broken cross reference security-frequent-issues in flow/security/overview.asciidoc
warn Broken cross reference ../components/flow-grid in flow/templates/polymer-template-and-binder.asciidoc
warn Broken cross reference ../routing/router-layout in flow/templates/parent-layout.asciidoc
warn Broken cross reference template-model-bean in flow/templates/event-handlers.asciidoc
warn Broken cross reference ../binding-data/flow-components-binder in flow/templates/and-binder.asciidoc
warn Broken cross reference ../components/flow-grid in flow/templates/and-binder.asciidoc
warn Broken cross reference ../binding-data/flow-components-binder in flow/web-components/java-api-for-a-web-component.asciidoc
warn Broken cross reference ../production/production-mode-basic in flow/templates/basic.asciidoc
warn Broken cross reference ../advanced/all-vaadin-properties in flow/web-components/integrating-a-web-component.asciidoc
warn Broken cross reference ../production/production-mode-advanced in flow/web-components/integrating-a-web-component.asciidoc
warn Broken cross reference templates/template-intro in flow/overview.asciidoc
warn Broken cross reference dnd/generic-dnd in flow/overview.asciidoc
warn Broken cross reference pwa/overview in flow/overview.asciidoc
warn Broken cross reference typescript-endpoints-generator in fusion/advanced/type-conversion.asciidoc
warn Broken internal reference UserEndpoints.ts in fusion/advanced/endpoints-generator.asciidoc
warn Broken cross reference ../introduction/overview in fusion/application/starting.asciidoc
warn Broken cross reference ../v15-migrationupgrading-from-vaadin14 in fusion/application/starting.asciidoc
warn Broken cross reference quick-start-guide in fusion/application/starting.asciidoc
warn Broken cross reference ../../flow/application/application-overview in fusion/application/overview.asciidoc
warn Broken cross reference ../../guide/introduction/overview in fusion/application/overview.asciidoc
warn Broken cross reference ../../fusion/routing/routing-defining in fusion/application/overview.asciidoc
warn Broken cross reference ../../fusion/routing/routing-defining in fusion/application/overview.asciidoc
warn Broken cross reference ../../fusion/security/fusion-security-overview in fusion/application/overview.asciidoc
warn Broken internal reference v15-migration/upgrading-from-vaadin14 in fusion/application/main-view.asciidoc
warn Broken cross reference type-conversion in fusion/application/client-exceptions.asciidoc
warn Broken cross reference starting-the-app in fusion/application/basics.asciidoc
warn Broken cross reference starting-the-app in fusion/application/basics.asciidoc
warn Broken cross reference creating-routes in fusion/application/basics.asciidoc
warn Broken cross reference creating-routes in fusion/application/basics.asciidoc
warn Broken cross reference ../advanced/fusion-advanced-type-conversion in fusion/application/accessing-backend.asciidoc
warn Broken cross reference ../binding-data/components-binder-validation in fusion/forms/binder-validation.asciidoc
warn Broken cross reference binder in fusion/forms/appendix-web-component-field-strategy.asciidoc
warn Broken cross reference binder in fusion/forms/appendix-vaadin-components.asciidoc
warn Broken cross reference binder in fusion/forms/appendix-vaadin-components.asciidoc
warn Broken cross reference ../advanced/modifying-the-bootstrap-page in fusion/routing/layouts.asciidoc
warn Broken cross reference ../java/routing-java-defining in fusion/routing/defining.asciidoc
warn Broken cross reference ../java/routing-java-defining in fusion/routing/defining.asciidoc
warn Broken cross reference quick-start-guide in fusion/security/spring-login.asciidoc
warn Broken cross reference ../../flow/security/flow-overview in fusion/security/overview.asciidoc
warn Broken cross reference ../advanced/fusion-advanced-client-middleware in fusion/security/handle-session-expiration.asciidoc
warn Broken cross reference fusion-security-spring-login in fusion/security/custom-spring-login.asciidoc
warn Broken cross reference fusion-security-spring-login in fusion/security/custom-spring-login.asciidoc
warn Broken cross reference adding-login-form-with-spring-security in fusion/security/configuring.asciidoc
warn Broken cross reference ../advanced/servlet-container-authentication in fusion/security/configuring.asciidoc
warn Broken cross reference check-user-login in fusion/security/configuring.asciidoc
warn Broken cross reference ../advanced/framework-security in fusion/security/configuring.asciidoc
warn Broken internal reference guide/installing/installing-overview in fusion/quick-start-tutorial.asciidoc
warn Broken cross reference ../guide/getting-started/intellij in fusion/quick-start-tutorial.asciidoc
warn Broken cross reference ../guide/getting-started/getting-started-eclipse in fusion/quick-start-tutorial.asciidoc
warn Broken cross reference ../guide/getting-started/getting-started-netbeans in fusion/quick-start-tutorial.asciidoc
warn Broken internal reference configuring-security in fusion/quick-start-tutorial.asciidoc
warn Broken internal reference theming/style-scopes in fusion/quick-start-tutorial.asciidoc
warn Broken internal reference routing/routing-defining in fusion/quick-start-tutorial.asciidoc
warn Broken cross reference configuring-security in fusion/security/authentication.asciidoc
warn Broken cross reference adding-login-form-with-spring-security in fusion/security/authentication.asciidoc
warn Broken cross reference check-user-login in fusion/security/authentication.asciidoc
warn Broken cross reference ../advanced/modifying-the-bootstrap-page in guide/configuration/pwa.asciidoc
warn Broken cross reference service-worker in guide/configuration/pwa.asciidoc
warn Broken cross reference icons in guide/configuration/pwa.asciidoc
warn Broken cross reference offline in guide/configuration/pwa.asciidoc
warn Broken cross reference offline in guide/configuration/pwa.asciidoc
warn Broken cross reference manifest in guide/configuration/pwa.asciidoc
warn Broken cross reference icons in guide/configuration/pwa.asciidoc
warn Broken cross reference flow-runtime-configuration in guide/configuration/npm-pnpm.asciidoc
warn Broken cross reference i18n-localization in guide/configuration/index.asciidoc
warn Broken cross reference ../../testbench/creating-tests in guide/contributing/web-component-integration-testing.asciidoc
warn Broken cross reference ../../flow/spring/configuration in guide/production/spring-boot.asciidoc
warn Broken cross reference ../typescript/creating-routes in guide/upgrading.asciidoc
warn Broken cross reference ../../v14/flow/migration/1-migrating-v8-v10 in guide/upgrading.asciidoc
warn Broken cross reference ../../v14/flow/v14-migration/v14-migration-guide in guide/upgrading.asciidoc
warn Broken cross reference ../../guide/installing/installing-overview in guide/start/gradle.asciidoc
warn Broken cross reference ../../guide/production/mode in guide/start/gradle.asciidoc
warn Broken cross reference ../../guide/production/mode in guide/start/gradle.asciidoc
warn Broken cross reference designer-installing-eclipse in tools/designer/getting-started/setting-up-your-environment.asciidoc
warn Broken cross reference ../../../ds/foundation/size-space/ in tools/designer/using-designer/layout.asciidoc
warn Broken cross reference {guide}/designer/getting-started/build-your-main-view in tools/designer/using-designer/java.asciidoc
warn Broken internal reference ../../flow/templates/template-components in tools/designer/using-designer/java.asciidoc
warn Broken internal reference {guide}/flow/templates/template-bindings in tools/designer/using-designer/java.asciidoc
warn Broken cross reference ../../../guide/production/mode in tools/mpr/configuration/production-mode.asciidoc
warn Broken cross reference ../../../guide/upgrading/v8-upgrade/routing-navigation in
tools/mpr/introduction/5-adding-legacy-components.asciidoc
warn Broken cross reference ../../../flow/routing/routing-overview in tools/mpr/introduction/5-adding-legacy-components.asciidoc
warn Broken internal reference 3-legacy-uis in tools/mpr/introduction/3-spring-boot.asciidoc
warn Broken cross reference ../../../flow/spring/spring-basic in tools/mpr/introduction/3-spring-boot.asciidoc
warn Broken cross reference step-3-navigator in tools/mpr/introduction/3-spring-boot.asciidoc
warn Broken internal reference 3-legacy-uis in tools/mpr/introduction/3-no-framework.asciidoc
warn Broken internal reference 3-legacy-uis in tools/mpr/introduction/3-navigator.asciidoc
warn Broken cross reference ../../../flow/routing/routing-lifecycle in tools/mpr/introduction/3-navigator.asciidoc
warn Broken internal reference step-3-legacy-uis in tools/mpr/introduction/3-cdi.asciidoc
warn Broken cross reference step-3-navigator in tools/mpr/introduction/3-cdi.asciidoc
warn Broken cross reference introduction/step-1-upgrade-guide in tools/mpr/overview.asciidoc
warn Broken cross reference configuration/mode in tools/mpr/overview.asciidoc
warn Broken cross reference dummy/../testbench-maintainable-tests-using-page-objects in tools/testbench/getting-started.asciidoc
warn Broken cross reference dummy/../testbench-running-test-on-multiple-browsers in tools/testbench/ci-server.asciidoc
warn <stdin>: SVG does not exist or cannot be read: /Users/jouni/Documents/dev/docs/articles/_images/testbenchicon.svg
jouni commented 3 years ago

Fixed in

jouni commented 3 years ago

There are a couple of false positives that the upcoming xref checker produces. I added a class name skip-xref-check to those, and we can update the checker to ignore them.