This is an automated email from the ASF dual-hosted git repository.
lindong pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-ml.git
The following commit(s) were added to refs/heads/master by this push:
new 0b2cbf5 [FLINK-26100] Add link to document website in README
0b2cbf5 is described below
commit 0b2cbf5c84245f5aea06ff3179ba405295105229
Author: yunfengzhou-hub <[email protected]>
AuthorDate: Wed Mar 30 17:28:38 2022 +0800
[FLINK-26100] Add link to document website in README
This PR adds a link to Flink ML's document website in README.md. The added
content is referenced from Flink repo's README.
This closes #75.
---
README.md | 27 ++++++++++++++++++++++-----
1 file changed, 22 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index eb1cb43..27633bc 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,34 @@
-Flink ML is a library which provides machine learning (ML) APIs and
infrastructures that simplify the building of ML pipelines. Users can implement
ML algorithms with the standard ML APIs and further use these infrastructures
to build ML pipelines for both training and inference jobs.
+Flink ML is a library which provides machine learning (ML) APIs and
+infrastructures that simplify the building of ML pipelines. Users can implement
+ML algorithms with the standard ML APIs and further use these infrastructures
to
+build ML pipelines for both training and inference jobs.
-Flink ML is developed under the umbrella of [Apache
Flink](https://flink.apache.org/).
+Flink ML is developed under the umbrella of [Apache
+Flink](https://flink.apache.org/).
## <a name="build"></a>Building the Project
Run the `mvn clean package` command.
-Then you will find a JAR file that contains your application, plus any
libraries that you may have added as dependencies to the application:
`target/<artifact-id>-<version>.jar`.
+Then you will find a JAR file that contains your application, plus any
libraries
+that you may have added as dependencies to the application:
+`target/<artifact-id>-<version>.jar`.
+
+## <a name="documentation"></a>Documentation
+
+The documentation of Flink ML is located on the website:
+https://nightlies.apache.org/flink/flink-ml-docs-master/ or in the docs/
+directory of the source code.
## <a name="contributing"></a>Contributing
-You can learn more about how to contribute in the [Apache Flink
website](https://flink.apache.org/contributing/how-to-contribute.html). For
code contributions, please read carefully the [Contributing
Code](https://flink.apache.org/contributing/contribute-code.html) section for
an overview of ongoing community work.
+You can learn more about how to contribute in the [Apache Flink
+website](https://flink.apache.org/contributing/how-to-contribute.html). For
code
+contributions, please read carefully the [Contributing
+Code](https://flink.apache.org/contributing/contribute-code.html) section for
an
+overview of ongoing community work.
## <a name="license"></a>License
-The code in this repository is licensed under the [Apache Software License
2](LICENSE).
+The code in this repository is licensed under the [Apache Software License
+2](LICENSE).
