Docs update
Project: http://git-wip-us.apache.org/repos/asf/cayenne/repo Commit: http://git-wip-us.apache.org/repos/asf/cayenne/commit/c04fa437 Tree: http://git-wip-us.apache.org/repos/asf/cayenne/tree/c04fa437 Diff: http://git-wip-us.apache.org/repos/asf/cayenne/diff/c04fa437 Branch: refs/heads/master Commit: c04fa437ace90918656a598b463a66208d85d98c Parents: ec58009 Author: Nikita Timofeev <stari...@gmail.com> Authored: Mon Aug 27 17:26:36 2018 +0300 Committer: Nikita Timofeev <stari...@gmail.com> Committed: Mon Aug 27 17:26:36 2018 +0300 ---------------------------------------------------------------------- .../part2-project-setup.adoc | 54 -------------------- .../part2-rr-setup.adoc | 25 ++++++++- 2 files changed, 24 insertions(+), 55 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cayenne/blob/c04fa437/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/_getting-started-db-first/part2-project-setup.adoc ---------------------------------------------------------------------- diff --git a/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/_getting-started-db-first/part2-project-setup.adoc b/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/_getting-started-db-first/part2-project-setup.adoc deleted file mode 100644 index 4663cb6..0000000 --- a/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/_getting-started-db-first/part2-project-setup.adoc +++ /dev/null @@ -1,54 +0,0 @@ -// Licensed to the Apache Software Foundation (ASF) under one or more -// contributor license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright ownership. -// The ASF licenses this file to you under the Apache License, Version -// 2.0 (the "License"); you may not use this file except in compliance -// with the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 Unless required by -// applicable law or agreed to in writing, software distributed under the -// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR -// CONDITIONS OF ANY KIND, either express or implied. See the License for -// the specific language governing permissions and limitations under the -// License. -=== Creating project - -Now we also need to create project file, currently this should be done manually via Cayenne Modeler. - -==== Setup Modeler Maven plugin - -To launch Modeler we'll use ``cayenne-modeler-maven-plugin``. -To use it just include it in `pom.xml` like we did with ``cayenne-maven-plugin``: -[source,xml] ----- -<plugin> - <groupId>org.apache.cayenne.plugins</groupId> - <artifactId>cayenne-modeler-maven-plugin</artifactId> - <version>${cayenne.version}</version> -</plugin> ----- - -To launch it simple use console: ----- -$ mvn cayenne-modeler:run ----- - -==== Create project - -In Modeler start new project and select `File` > ``Import DataMap``. -In File Select dialog select created `datamap.map.xml` file and click ``Select DataMap``. -Now all we need is to save project, click `Save` and select same folder where `datamap.map.xml` file is -(it should be selected by default). -That's all, you should see now `cayenne-project.xml` file in IDEA: - -image::tutorial-cayenne-project.png[align="center"] - -To use newly created project in Modeler later let's configure plugin to open it automatically: -[source,xml] ----- -<plugin> - ... - <configuration> - <modelFile>${project.basedir}/src/main/resources/cayenne-project.xml</modelFile> - </configuration> ----- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cayenne/blob/c04fa437/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/_getting-started-db-first/part2-rr-setup.adoc ---------------------------------------------------------------------- diff --git a/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/_getting-started-db-first/part2-rr-setup.adoc b/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/_getting-started-db-first/part2-rr-setup.adoc index 07e89a7..d48f6cf 100644 --- a/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/_getting-started-db-first/part2-rr-setup.adoc +++ b/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/_getting-started-db-first/part2-rr-setup.adoc @@ -105,4 +105,27 @@ image::tutorial-new-datamap.png[align="center"] Great! We now have Cayenne DataMap file that describe model from our database and cayenne-project.xml file. -NOTE: If you have some problems with configuration you can always delete `datamap.map.xml` file and try again. \ No newline at end of file +NOTE: If you have some problems with configuration you can always delete `datamap.map.xml` file and try again. + +==== Setup Modeler Maven plugin + +Cayenne Modeler can be helpful in case you want to make some customizations to your model, though it's usage optional. + +To launch Modeler we'll use ``cayenne-modeler-maven-plugin``. +Just include it in `pom.xml` like we did with ``cayenne-maven-plugin`` and tell where your project is: +[source,xml] +---- +<plugin> + <groupId>org.apache.cayenne.plugins</groupId> + <artifactId>cayenne-modeler-maven-plugin</artifactId> + <version>${cayenne.version}</version> + <configuration> + <modelFile>${project.basedir}/src/main/resources/cayenne-project.xml</modelFile> + </configuration> +</plugin> +---- + +To launch it simply run: +---- +$ mvn cayenne-modeler:run +---- \ No newline at end of file