Skip to content

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

Merged
RocMarshal merged 1 commit into
apache:release-2.3from
Samrat002:FLINK-39118-native-s3-documentation
Apr 18, 2026
Merged

[FLINK-39118][docs] Add documentation for Native s3 FileSystem#27937
RocMarshal merged 1 commit into
apache:release-2.3from
Samrat002:FLINK-39118-native-s3-documentation

Conversation

@Samrat002
Copy link
Copy Markdown
Contributor

What is the purpose of the change

Add documentation for Native s3 FileSystem

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-04-15 at 10 37 11 PM Screenshot 2026-04-15 at 10 37 24 PM

Chinese Doc Render :

Screenshot 2026-04-15 at 10 37 48 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 Apr 16, 2026

CI report:

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

Comment thread docs/content.zh/docs/deployment/filesystems/s3.md
@github-actions github-actions Bot added target:release-2.3 community-reviewed PR has been reviewed by the community. labels Apr 16, 2026
Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
Comment thread docs/content/docs/deployment/filesystems/s3.md
@Samrat002 Samrat002 force-pushed the FLINK-39118-native-s3-documentation branch from 53de5b0 to b35df7d Compare April 16, 2026 14:18
@Samrat002 Samrat002 requested review from davidradl and spuru9 April 16, 2026 14:18
Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
@Samrat002 Samrat002 requested a review from davidradl April 16, 2026 16:47
@Samrat002 Samrat002 force-pushed the FLINK-39118-native-s3-documentation branch from 21e7d4c to ed83cc8 Compare April 17, 2026 06:56
Comment thread docs/content/docs/deployment/filesystems/s3.md
Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
@Samrat002 Samrat002 force-pushed the FLINK-39118-native-s3-documentation branch from ed83cc8 to fdd683e Compare April 17, 2026 09:24
@Samrat002 Samrat002 requested a review from davidradl April 17, 2026 09:25
@RocMarshal RocMarshal self-assigned this Apr 18, 2026
@RocMarshal
Copy link
Copy Markdown
Contributor

Hi, @Samrat002 Could the patch use cherry-pick to keep the commit-id(of the main branch) ? Thank you.

@Samrat002 Samrat002 force-pushed the FLINK-39118-native-s3-documentation branch from fdd683e to 49127a7 Compare April 18, 2026 07:39
@Samrat002
Copy link
Copy Markdown
Contributor Author

Hi @RocMarshal, done! I've cherry-picked the commit from the master branch (565dbbc). Thank you!

@RocMarshal RocMarshal merged commit bbca7c9 into apache:release-2.3 Apr 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-reviewed PR has been reviewed by the community. target:release-2.3

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants