Skip to content

[FLINK-39118] Add documentation for Native s3 FileSystem#27841

Open
Samrat002 wants to merge 1 commit intoapache:masterfrom
Samrat002:FLINK-39118-native-s3-documentation
Open

[FLINK-39118] Add documentation for Native s3 FileSystem#27841
Samrat002 wants to merge 1 commit intoapache:masterfrom
Samrat002:FLINK-39118-native-s3-documentation

Conversation

@Samrat002
Copy link
Copy Markdown
Contributor

@Samrat002 Samrat002 commented Mar 27, 2026

What is the purpose of the change

Add documentation for Native s3 FileSystem

Please note that this patch does not update the Chinese document yet. This will be done once english document content is reached to consensus.

Brief change log

Add documentation and show how to use new s3Filesystem.

Verifying this change

Build the docs in local using Hugo

 ~/C/O/flink/docs │ on FLINK-39118-…ocumentation !1 ▓▒░ docker run -v $(pwd):/src -p 1313:1313 jakejarvis/hugo-extended:latest server --buildDrafts --buildFuture --bind 0.0.0.0
Watching for changes in /src/{assets,content,content.zh,data,layouts,static,themes}
Watching for config changes in /src/config.toml, /src/themes/connectors/config.yaml
Start building sites … 
hugo v0.124.1-db083b05f16c945fec04f745f0ca8640560cf1ec+extended linux/arm64 BuildDate=2024-03-20T11:40:10Z VendorInfo=docker


                   | EN  | ZH   
-------------------+-----+------
  Pages            | 502 | 500  
  Paginator pages  |   0 |   0  
  Non-page files   |   0 |   0  
  Static files     | 266 | 266  
  Processed images |   0 |   0  
  Aliases          | 419 | 416  
  Cleaned          |   0 |   0  

Built in 7938 ms
Environment: "development"
Serving pages from disk
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at //localhost:1313/flink/flink-docs-master/ (bind address 0.0.0.0) 
Press Ctrl+C to stop
Screenshot 2026-03-27 at 3 24 33 PM Screenshot 2026-03-27 at 3 23 33 PM Screenshot 2026-03-27 at 3 23 42 PM Screenshot 2026-03-27 at 3 24 05 PM Screenshot 2026-03-27 at 3 24 22 PM Screenshot 2026-03-27 at 3 24 33 PM

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (yes / no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): (yes / no)
  • The serializers: (yes / no / don't know)
  • The runtime per-record code paths (performance sensitive): (yes / no / don't know)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (yes / no / don't know)
  • The S3 file system connector: (yes / no / don't know)

Documentation

  • Does this pull request introduce a new feature? (yes / no) no

  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented) yes

@flinkbot
Copy link
Copy Markdown
Collaborator

flinkbot commented Mar 27, 2026 •
edited
Loading

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Samrat002 @flinkbot