Skip to content

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

Merged
RocMarshal merged 2 commits intoapache:masterfrom
Samrat002:FLINK-39118-native-s3-documentation
Apr 18, 2026
Merged

[FLINK-39118][docs] Add documentation for Native s3 FileSystem#27841
RocMarshal merged 2 commits 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

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 Mar 27, 2026

CI report:

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

Copy link
Copy Markdown
Contributor

@alpinegizmo alpinegizmo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is in pretty good shape. Just a couple of points to address.

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 7b82717 to 7be000d Compare March 31, 2026 17:51
@Samrat002 Samrat002 requested a review from alpinegizmo March 31, 2026 17:55
Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
Copy link
Copy Markdown
Contributor

@alpinegizmo alpinegizmo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more suggestion, and a question.

Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
@Samrat002 Samrat002 requested a review from alpinegizmo April 1, 2026 05:05
Copy link
Copy Markdown
Contributor

@Izeren Izeren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR @Samrat002, I have left a few comments, PTAL.

My general request for changes is to replicate this for Chinese docs (usually we update both): https://github.com/apache/flink/blob/master/docs/content.zh/docs/deployment/filesystems/s3.md

It can be done in English for further translation.

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
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
Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
@github-actions github-actions bot added the community-reviewed PR has been reviewed by the community. label Apr 1, 2026
@Samrat002 Samrat002 requested a review from Izeren April 3, 2026 04:18
@Samrat002 Samrat002 force-pushed the FLINK-39118-native-s3-documentation branch from a1af097 to a0429ed Compare April 8, 2026 05:28
@Samrat002
Copy link
Copy Markdown
Contributor Author

Thank you for the PR @Samrat002, I have left a few comments, PTAL.

My general request for changes is to replicate this for Chinese docs (usually we update both): https://github.com/apache/flink/blob/master/docs/content.zh/docs/deployment/filesystems/s3.md

It can be done in English for further translation.

I have added a note in the PR description earlier. Once the English version content is good. I will add changes for chinese doc in this pr itself as a new commit.

Copy link
Copy Markdown
Contributor

@Izeren Izeren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you for addressing feedback, @Samrat002

Comment thread docs/content/docs/deployment/filesystems/s3.md Outdated
Copy link
Copy Markdown
Contributor

@alpinegizmo alpinegizmo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the improvements!

@Samrat002 Samrat002 force-pushed the FLINK-39118-native-s3-documentation branch 2 times, most recently from 21c9344 to 4265f70 Compare April 14, 2026 17:30
Copy link
Copy Markdown
Contributor

@gaborgsomogyi gaborgsomogyi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically looks good, some minor tweaks and good to go

Comment thread docs/content.zh/docs/deployment/filesystems/s3.md Outdated
Comment thread docs/content.zh/docs/deployment/filesystems/s3.md Outdated
@Samrat002 Samrat002 force-pushed the FLINK-39118-native-s3-documentation branch from 4265f70 to f309c80 Compare April 15, 2026 17:05
@Samrat002
Copy link
Copy Markdown
Contributor Author

@gaborgsomogyi PTAL at the updated changes

@Samrat002 Samrat002 requested a review from gaborgsomogyi April 15, 2026 17:10
Comment thread docs/content.zh/docs/deployment/filesystems/s3.md
Comment thread docs/content.zh/docs/deployment/filesystems/s3.md Outdated
@Samrat002 Samrat002 force-pushed the FLINK-39118-native-s3-documentation branch 2 times, most recently from 21e7d4c to ed83cc8 Compare April 17, 2026 06:56
@Samrat002 Samrat002 force-pushed the FLINK-39118-native-s3-documentation branch from ed83cc8 to fdd683e Compare April 17, 2026 09:24
@RocMarshal RocMarshal changed the title [FLINK-39118] Add documentation for Native s3 FileSystem [FLINK-39118][docs] Add documentation for Native s3 FileSystem Apr 18, 2026
@RocMarshal
Copy link
Copy Markdown
Contributor

Thanks @Samrat002 for the PR and @alpinegizmo @gaborgsomogyi @Izeren for the review.
Merging...

@RocMarshal RocMarshal merged commit 565dbbc into apache:master Apr 18, 2026
Samrat002 added a commit to Samrat002/flink that referenced this pull request 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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants