You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ch...@apache.org on 2022/11/10 13:56:48 UTC
[flink] branch release-1.16 updated (b9ec6217b02 -> 7ae60884e5e)
This is an automated email from the ASF dual-hosted git repository.
chesnay pushed a change to branch release-1.16
in repository https://gitbox.apache.org/repos/asf/flink.git
from b9ec6217b02 [FLINK-29973][docs] connector_artifact appends Minor version
new 956c249f336 [FLINK-29972][docs] Use Elasticsearch 3.0.0 docs
new 8b3ce290628 [hotfix] Update Documentation integration docs
new 7ae60884e5e [hotfix] Document connector_artifact shortcode
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/README.md | 70 +++++++++++++-----------------------------------------
docs/setup_docs.sh | 2 +-
2 files changed, 18 insertions(+), 54 deletions(-)
[flink] 03/03: [hotfix] Document connector_artifact shortcode
Posted by ch...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
chesnay pushed a commit to branch release-1.16
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 7ae60884e5e91aa70b009367a5aa4c70b7e137f4
Author: Chesnay Schepler <ch...@apache.org>
AuthorDate: Thu Nov 10 09:38:25 2022 +0100
[hotfix] Document connector_artifact shortcode
---
docs/README.md | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/docs/README.md b/docs/README.md
index e1167833496..cafa70664b1 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -144,6 +144,20 @@ You can also use the shortcodes (with same flags) instead:
* `artifact_gradle` to show the Gradle syntax
* `artifact_tabs` to create a tabbed view, showing both Maven and Gradle syntax
+#### Flink Connector Artifact
+
+ {{< connector_artifact flink-connector-elasticsearch 3.0.0 >}}
+
+This will be replaced by the maven artifact for flink-connector-elasticsearch that users should copy into their pom.xml file. It will render out to:
+
+```xml
+<dependency>
+ <groupId>org.apache.flink</groupId>
+ <artifactId>flink-connector-elasticsearch</artifactId>
+ <version>3.0.0</version>
+</dependency>
+```
+
#### Back to Top
{{< top >}}
[flink] 02/03: [hotfix] Update Documentation integration docs
Posted by ch...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
chesnay pushed a commit to branch release-1.16
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 8b3ce290628591c1e9540d9c813d76861ada13a9
Author: Chesnay Schepler <ch...@apache.org>
AuthorDate: Thu Nov 10 09:38:10 2022 +0100
[hotfix] Update Documentation integration docs
---
docs/README.md | 56 +++-----------------------------------------------------
1 file changed, 3 insertions(+), 53 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 2a885dd55f0..e1167833496 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -41,64 +41,14 @@ With the ongoing efforts to move Flink's connectors from this repository to indi
repositories, this also requires the documentation to be hosted outside this repo. However,
we still want to serve all documentation as a whole on the Flink documentation website.
-In order to achieve this, we're using [Hugo Modules.](https://gohugo.io/hugo-modules/configuration/)
-to create a virtual filesystem.
-
Adding new externally hosted documentation requires the following steps to be taken:
1. (If necessary) Move the existing documentation to the new repository
-2. In this new repository, in the `docs` folder, create a file `go.mod` containing:
-
-```go
-module github.com/apache/flink-connector-<repositoryname>/docs
-
-go 1.18
-```
-Replace <repositoryname> with the name of your repository.
-See https://github.com/apache/flink-connector-elasticsearch/tree/main/docs/go.mod for an example.
-3. In this new repository, in the `docs` folder, create a `config.toml` file containing:
-
-```yaml
-module:
- mounts:
- - source: content
- target: content
- lang: en
- - source: content.zh
- target: content.zh
- lang: zh
-```
-
-See https://github.com/apache/flink-connector-elasticsearch/tree/main/docs/config.toml for an example.
-
-4. In the Flink repository, edit the `docs/setup_docs.sh` file and add a reference to your now
-externally hosted documentation. The reference will look like `hugo mod get -u github.com/apache/<reponame>/docs@main`
-
-Replace <repositoryname> with the name of your repository.
-
-5. In the Flink repository, edit the `docs/config.toml` file add the files from the external
-repository as a mount to the Flink documentation. Hugo creates a virtual mount, meaning that any
-mounted file will appear as if it's located in this repository.
-
-```yaml
-[module]
-[[module.imports]]
- path = 'github.com/apache/<repositoryname>/docs'
-[[module.imports.mounts]]
- source = 'content'
- target = 'content'
- lang = 'en'
-[[module.imports.mounts]]
- source = 'content.zh'
- target = 'content'
- lang = 'zh'
-```
+2. In the Flink repository, edit the `docs/setup_docs.sh` file and add a reference to your now
+externally hosted documentation. The reference will look like `integrate_connector_docs <connector_name> <branch_or_tag>`.
-Replace <repositoryname> with the name of your repository.
-The Chinese documentation source `content.zh` is targetted to the actual `content` folder.
-Hugo combines the `target` and `lang` to display the correct language.
-See the current `docs/config.toml` file for an example.
+Replace <connector_name> with the name of your connector, e.g., `elasticsearch` for `flink-connector-elasticsearch`.
## Generate configuration tables
[flink] 01/03: [FLINK-29972][docs] Use Elasticsearch 3.0.0 docs
Posted by ch...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
chesnay pushed a commit to branch release-1.16
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 956c249f3362b1dbcd4492f21d2cd0d67fc4a229
Author: Chesnay Schepler <ch...@apache.org>
AuthorDate: Thu Nov 10 09:46:44 2022 +0100
[FLINK-29972][docs] Use Elasticsearch 3.0.0 docs
---
docs/setup_docs.sh | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/setup_docs.sh b/docs/setup_docs.sh
index 164e5b39674..773b8533fed 100755
--- a/docs/setup_docs.sh
+++ b/docs/setup_docs.sh
@@ -53,7 +53,7 @@ cd tmp
# Since there's no documentation yet available for a release branch,
# we only get the documentation from the main branch
-integrate_connector_docs elasticsearch main
+integrate_connector_docs elasticsearch v3.0.0
cd ..
rm -rf tmp