zentol commented on a change in pull request #11100: [FLINK-15562][docs] Add
Example settings.xml for maven archetype command wh…
URL: https://github.com/apache/flink/pull/11100#discussion_r381305610
##########
File path: docs/dev/projectsetup/java_api_quickstart.md
##########
@@ -53,28 +53,47 @@ Use one of the following commands to __create a project__:
</ul>
<div class="tab-content">
<div class="tab-pane active" id="maven-archetype">
- {% highlight bash %}
- $ mvn archetype:generate \
- -DarchetypeGroupId=org.apache.flink \
- -DarchetypeArtifactId=flink-quickstart-java \{% unless
site.is_stable %}
-
-DarchetypeCatalog=https://repository.apache.org/content/repositories/snapshots/
\{% endunless %}
- -DarchetypeVersion={{site.version}}
- {% endhighlight %}
+{% highlight bash %}
+$ mvn archetype:generate \
+ -DarchetypeGroupId=org.apache.flink \
+ -DarchetypeArtifactId=flink-quickstart-java \{% unless site.is_stable %}
+
-DarchetypeCatalog=https://repository.apache.org/content/repositories/snapshots/
\{% endunless %}
+ -DarchetypeVersion={{site.version}}
+{% endhighlight %}
This allows you to <strong>name your newly created project</strong>.
It will interactively ask you for the groupId, artifactId, and package name.
</div>
<div class="tab-pane" id="quickstart-script">
- {% highlight bash %}
+{% highlight bash %}
{% if site.is_stable %}
- $ curl https://flink.apache.org/q/quickstart.sh | bash -s {{site.version}}
+$ curl https://flink.apache.org/q/quickstart.sh | bash -s {{site.version}}
{% else %}
- $ curl https://flink.apache.org/q/quickstart-SNAPSHOT.sh | bash -s
{{site.version}}
+$ curl https://flink.apache.org/q/quickstart-SNAPSHOT.sh | bash -s
{{site.version}}
{% endif %}
- {% endhighlight %}
+{% endhighlight %}
</div>
{% unless site.is_stable %}
<p style="border-radius: 5px; padding: 5px" class="bg-danger">
- <b>Note</b>: For Maven 3.0 or higher, it is no longer possible to
specify the repository (-DarchetypeCatalog) via the command line. If you wish
to use the snapshot repository, you need to add a repository entry to your
settings.xml. For details about this change, please refer to <a
href="http://maven.apache.org/archetype/maven-archetype-plugin/archetype-repository.html";>Maven
official document</a>
+ <b>Note</b>: For Maven 3.0 or higher, it is no longer possible to
specify the repository (-DarchetypeCatalog) via the command line. For details
about this change, please refer to <a
href="http://maven.apache.org/archetype/maven-archetype-plugin/archetype-repository.html";>Maven
official document</a>
+ If you wish to use the snapshot repository, you need to add a
repository entry to your settings.xml. For example:
Review comment:
snapshots should at no point be advertised to users. They purely exist for
dev purposes.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
