From 0b7457325200162961cae52e7d871db928dc3cd9 Mon Sep 17 00:00:00 2001 From: Zhe Sun <31067185+ZheSun88@users.noreply.github.com> Date: Thu, 23 May 2019 09:43:31 +0300 Subject: Update broken docs syntax in github (#11596) * Add delay to the unstable test * Add delay for unstable tests * Update broken docs syntax in github * Merge branch 'master' into ZheSun88-patch-1 * Update doc reference syntax * Merge branch 'ZheSun88-patch-1' of github.com:vaadin/framework into ZheSun88-patch-1 # Conflicts: # documentation/components/components-overview.asciidoc * Merge branch 'master' into ZheSun88-patch-1 * use .asciidoc * Merge remote-tracking branch 'origin/ZheSun88-patch-1' into ZheSun88-patch-1 * use .asciidoc * Merge branch 'master' into ZheSun88-patch-1 --- .../chapter-getting-started.asciidoc | 4 ++-- .../getting-started-first-project.asciidoc | 6 +++--- .../getting-started/getting-started-idea.asciidoc | 2 +- .../getting-started-libraries.asciidoc | 6 +++--- .../getting-started/getting-started-maven.asciidoc | 4 ++-- .../getting-started-netbeans.asciidoc | 6 +++--- .../getting-started/getting-started-overview.adoc | 21 --------------------- .../getting-started-overview.asciidoc | 21 +++++++++++++++++++++ 8 files changed, 35 insertions(+), 35 deletions(-) delete mode 100644 documentation/getting-started/getting-started-overview.adoc create mode 100644 documentation/getting-started/getting-started-overview.asciidoc (limited to 'documentation/getting-started') diff --git a/documentation/getting-started/chapter-getting-started.asciidoc b/documentation/getting-started/chapter-getting-started.asciidoc index 329e40cf3a..8c7f0adb2e 100644 --- a/documentation/getting-started/chapter-getting-started.asciidoc +++ b/documentation/getting-started/chapter-getting-started.asciidoc @@ -1,13 +1,13 @@ [[getting-started]] == Creating a Vaadin Application -TIP: If you are new to Vaadin, we suggest to start with <>. It also contains instructions how to set up Eclipse based development environment. +TIP: If you are new to Vaadin, we suggest to start with <<../tutorial#tutorial,"the tutorial">>. It also contains instructions how to set up Eclipse based development environment. This chapter gives practical instructions for creating a Vaadin application project and deploying it to a server to run it. We also consider topics such as debugging. The instructions are given separately for the Eclipse IDE, NetBeans, and IntelliJ IDEA. -include::getting-started-overview.adoc[leveloffset=+2] +include::getting-started-overview.asciidoc[leveloffset=+2] include::getting-started-libraries.asciidoc[leveloffset=+2] diff --git a/documentation/getting-started/getting-started-first-project.asciidoc b/documentation/getting-started/getting-started-first-project.asciidoc index 3903af15f5..4d9be5d86d 100644 --- a/documentation/getting-started/getting-started-first-project.asciidoc +++ b/documentation/getting-started/getting-started-first-project.asciidoc @@ -7,7 +7,7 @@ layout: page [[getting-started.first-project]] = Creating and Running a Project in Eclipse -TIP: If you are new to Vaadin, we suggest to start with <>. It also contains instructions how to set up Eclipse based development environment. +TIP: If you are new to Vaadin, we suggest to start with <<../tutorial#tutorial,"the tutorial">>. It also contains instructions how to set up Eclipse based development environment. This section gives instructions for creating a new Eclipse project using the Vaadin Plugin. The task will include the following steps: @@ -23,7 +23,7 @@ Vaadin Plugin. The task will include the following steps: We also show how you can debug the application in the debug mode in Eclipse. This walkthrough assumes that you have already installed the Eclipse IDE, the Vaadin Plugin, and a development server, as instructed in -<>. +<<../installing/installing-eclipse#installing.eclipse, "Installing the Eclipse IDE and Plugin">>. [[getting-started.first-project.creation]] == Creating a Maven Project @@ -207,7 +207,7 @@ image::img/debuggingMyProject.png[scaledwidth=100%] Above, we described how to debug a server-side application. Debugging client-side applications and widgets is described in -<>. +<<../clientside/clientside-debugging#clientside.debugging,"Debugging Client-Side Code">>. [[getting-started.eclipse.mavenlibraryupdate]] == Updating the Vaadin Framework Libraries diff --git a/documentation/getting-started/getting-started-idea.asciidoc b/documentation/getting-started/getting-started-idea.asciidoc index f677e06e42..88e93e75ce 100644 --- a/documentation/getting-started/getting-started-idea.asciidoc +++ b/documentation/getting-started/getting-started-idea.asciidoc @@ -61,7 +61,7 @@ To compile a Vaadin application using Maven, you can define a run/debug configuration to execute a goal such as [literal]#++package++# to build the deployable WAR package. It will also compile the widget set and theme, if necessary. See -<> for more details. Compilation is included in the following instructions for deploying the diff --git a/documentation/getting-started/getting-started-libraries.asciidoc b/documentation/getting-started/getting-started-libraries.asciidoc index 39802e91b0..6d1f4fcf83 100644 --- a/documentation/getting-started/getting-started-libraries.asciidoc +++ b/documentation/getting-started/getting-started-libraries.asciidoc @@ -13,7 +13,7 @@ applications, whether you use add-on components, or use CSS or Sass themes. [filename]#vaadin-server-8.x.x.jar#:: The main library for developing server-side Vaadin applications, as described in -<>. +<<../application/application-overview.asciidoc#application.overview,"Writing a Server-Side Web Application">>. It requires the [filename]#vaadin-shared# and the [filename]#vaadin-themes# libraries. You can use the pre-built [filename]#vaadin-client-compiled# for server-side development, unless you need add-on components or custom widgets. @@ -41,10 +41,10 @@ You should not deploy it with a web application. [filename]#vaadin-client-compiler-8.x.x.jar#:: The Vaadin Client Compiler is a Java-to-JavaScript compiler that allows building client-side modules, such as the Client-Side Engine (widget set) required for server-side applications. -The compiler is needed, for example, for compiling add-on components to the application widget set, as described in <>. +The compiler is needed, for example, for compiling add-on components to the application widget set, as described in <<../addons/addons-overview.asciidoc#addons.overview,"Using Vaadin Add-ons">>. + For detailed information regarding the compiler, see -<>. +<<../clientside/clientside-compiling#clientside.compiling,"Compiling a Client-Side Module">>. Note that you should not deploy this library with a web application. [filename]#vaadin-compatibility-*-8.x.x.jar#:: diff --git a/documentation/getting-started/getting-started-maven.asciidoc b/documentation/getting-started/getting-started-maven.asciidoc index e58453c574..6d86448d88 100644 --- a/documentation/getting-started/getting-started-maven.asciidoc +++ b/documentation/getting-started/getting-started-maven.asciidoc @@ -44,7 +44,7 @@ The parameters are as follows: archetypes. [parameter]#archetypeArtifactId#:: The archetype ID. -See the list of available archetypes in <>. +See the list of available archetypes in <>. [parameter]#archetypeVersion#:: Version of the archetype to use. @@ -106,7 +106,7 @@ http://localhost:8080/project-name. ((("Maven", "using add-ons", id="term.maven.addons", range="startofrange"))) If you use Vaadin add-ons from the http://vaadin.com/directory[Vaadin Directory], you need to add them as dependencies in the project POM. -The instructions are given in <>. _In projects that use Vaadin 7.6 or older_, you need to compile the widget set manually. diff --git a/documentation/getting-started/getting-started-netbeans.asciidoc b/documentation/getting-started/getting-started-netbeans.asciidoc index 64948471fe..934c90c644 100644 --- a/documentation/getting-started/getting-started-netbeans.asciidoc +++ b/documentation/getting-started/getting-started-netbeans.asciidoc @@ -9,7 +9,7 @@ layout: page In the following, we walk you through the creation of a Vaadin project in NetBeans and show how to run it. -Installation of NetBeans and the Vaadin plugin is covered in <>. +Installation of NetBeans and the Vaadin plugin is covered in <<../installing/installing-netbeans#installing.netbeans, "Installing the NetBeans IDE and Plugin">>. Without the plugin, you can most easily create a Vaadin project as a Maven project using a Vaadin archetype. You can also create a Vaadin project as a @@ -70,11 +70,11 @@ image::img/netbeans-created-annotated-hi.png[width=80%, scaledwidth=100%] [filename]#mytheme#:: The theme of the UI. -See <> for information about themes. +See <<../themes/themes-overview#themes.overview, "Themes">> for information about themes. [filename]#MyUI.java#:: The UI class, which is the main entry-point of your application. -See <> for information about the basic structure of Vaadin applications. +See <<../application/application-overview#application.overview, "Server-Side Applications">> for information about the basic structure of Vaadin applications. The Vaadin libraries and other dependencies are managed by Maven. Notice that the libraries are not stored under the project folder, even though they are listed in the "Java Resources > Libraries > Maven Dependencies" virtual folder. diff --git a/documentation/getting-started/getting-started-overview.adoc b/documentation/getting-started/getting-started-overview.adoc deleted file mode 100644 index 3cf8b870f4..0000000000 --- a/documentation/getting-started/getting-started-overview.adoc +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Overview -order: 1 -layout: page ---- - -[[getting-started.overview]] -= Overview - -Once you have installed a development environment, as described in the previous chapter, creating a Vaadin Framework project proceeds in the IDE that you have chosen. - -The Vaadin Framework core library and all Vaadin add-ons are available through Maven, a commonly used build and dependency management system. - -The recommended way to create a Vaadin application project is to use a Maven archetype. -The archetypes contain all the needed dependencies, which Maven takes care of. - -In this chapter, we: - -* Give an overview of the Vaadin Framework libraries -* List the available Maven archetypes -* Give step-by-step instructions for creating a project in the Eclipse IDE, NetBeans IDE, and IntelliJ IDEA, as well as with command-line. diff --git a/documentation/getting-started/getting-started-overview.asciidoc b/documentation/getting-started/getting-started-overview.asciidoc new file mode 100644 index 0000000000..3cf8b870f4 --- /dev/null +++ b/documentation/getting-started/getting-started-overview.asciidoc @@ -0,0 +1,21 @@ +--- +title: Overview +order: 1 +layout: page +--- + +[[getting-started.overview]] += Overview + +Once you have installed a development environment, as described in the previous chapter, creating a Vaadin Framework project proceeds in the IDE that you have chosen. + +The Vaadin Framework core library and all Vaadin add-ons are available through Maven, a commonly used build and dependency management system. + +The recommended way to create a Vaadin application project is to use a Maven archetype. +The archetypes contain all the needed dependencies, which Maven takes care of. + +In this chapter, we: + +* Give an overview of the Vaadin Framework libraries +* List the available Maven archetypes +* Give step-by-step instructions for creating a project in the Eclipse IDE, NetBeans IDE, and IntelliJ IDEA, as well as with command-line. -- cgit v1.2.3