MartijnVisser opened a new pull request, #19571:
URL: https://github.com/apache/flink/pull/19571

   ## What is the purpose of the change
   
   As part of [FLINK-27393](https://issues.apache.org/jira/browse/FLINK-27393), 
the documentation of Elasticsearch will be moved to 
apache/flink-connector-elasticsearch
   
   However, we would still like to display the Elasticsearch documentation 
(which is then hosted outside of apache/flink) to appear in the same way this 
is currently done. This PR makes that possible. 
   
   
   ## Brief change log
   
   48a592b4983ec598cb35836394984e29bf2a0ac6 documents how you can add 
externally hosted documentation
   2ac2b34058256c67f9851bd5f38cd60ab29c6db3 removes the current Elasticsearch 
documentation
   7e8eae94ae4b3f3b535128f99621747d11b49fb1 updates the documentation build 
pipeline to make sure that the Elasticsearch documentation gets updated before 
building it
   7ac4ae9c49b037ea3b0637f3356245fc69699f35 adds the Elasticsearch 
documentation from https://github.com/apache/flink-connector-elasticsearch as a 
Hugo Module to the virtual Hugo mount/filesystem. Note: this doesn't yet work, 
since https://github.com/apache/flink-connector-elasticsearch/pull/12 is not 
merged yet. When that is merged, this commit needs to be updated. 
   
   ## Verifying this change
   
   You can verify that this change works by having Hugo installed and running 
`hugo config mounts`. You'll see something like:
   
   ```
   {
      "path": "github.com/apache/flink-connector-elasticsearch/docs",
      "version": "v0.0.0-20220425092437-8e4b91cb3984",
      "time": "2022-04-25T09:24:37Z",
      "owner": "github.com/apache/flink",
      "dir": 
"/var/folders/vy/p3hq5hts1wlbs4ycpxj82p5r0000gn/T/hugo_cache/modules/filecache/modules/pkg/mod/github.com/!apache/flink-connector-elasticsearch/docs@v0.0.0-20220425092437-8e4b91cb3984/",
      "mounts": [
         {
            "source": "content",
            "target": "content"
         }
      ]
   }
   ```
   
   You can further verify this by building the documentation locally via the 
usual command (see `docs/README.md`)
   
   ## Does this pull request potentially affect one of the following parts:
   
     - Dependencies (does it add or upgrade a dependency): no
     - The public API, i.e., is any changed class annotated with 
`@Public(Evolving)`: no
     - The serializers: no
     - The runtime per-record code paths (performance sensitive): no
     - Anything that affects deployment or recovery: JobManager (and its 
components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
     - The S3 file system connector: no
   
   ## Documentation
   
     - Does this pull request introduce a new feature? no
     - If yes, how is the feature documented? documented in the Flink 
documentation README
   


-- 
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.

To unsubscribe, e-mail: issues-unsubscr...@flink.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to