Skip to content

[FLINK-38945][docs][FLIP-561] Restructure Flink documentation#27541

Open
MartijnVisser wants to merge 16 commits intoapache:masterfrom
MartijnVisser:refactor-documentation
Open

[FLINK-38945][docs][FLIP-561] Restructure Flink documentation#27541
MartijnVisser wants to merge 16 commits intoapache:masterfrom
MartijnVisser:refactor-documentation

Conversation

@MartijnVisser
Copy link
Contributor

@MartijnVisser MartijnVisser commented Feb 5, 2026

What is the purpose of the change

Brief change log

This PR contains multiple commits, that should ultimately be squashed before merging. What's basically done is:

  1. Move the content to the right new location, change refs and add aliases for redirecting users to the new pages
  2. Add stub pages that redirect to the new location, given that externalized connectors docs are sometimes pointing to pages that no longer exist there, but have been moved. But we can't update the external connector docs because the new locations don't exist yet. This needs to be fixed afterwards
  3. Added new content for Getting Started and Learn Flink sections where needed
  4. Rewrote "First Steps" completely
  5. Added a Table API archetype

I also included a couple of nice to haves/extra:

  1. No longer show Google Analytics warnings when building the docs
  2. Fixed a JS sync bug in the docs when you were switching between different languages (Java/Scala/Python) and the browser not updating the right tab anymore
  3. Added a copy button for code blocks

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.
Verification has happened by checking out the PR and building it with Hugo locally

image image image image image image image image image

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)
  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

@flinkbot
Copy link
Collaborator

flinkbot commented Feb 5, 2026

CI report:

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

@MartijnVisser MartijnVisser force-pushed the refactor-documentation branch from 72d5849 to 5579697 Compare February 5, 2026 19:05
@rionmonster
Copy link
Contributor

rionmonster commented Feb 5, 2026

@MartijnVisser

Thanks for the PR!

I've been following the restructuring efforts on the mailing list, so I'm glad to see it progressing., I noticed a handful of RAT-related failures when attempting to build things locally which triggered a validation failure with was also reflected in CI:

[ERROR] Failed to execute goal org.apache.rat:apache-rat-plugin:0.13:check (default) on project flink-parent: Too many files with unapproved license: 41 See RAT report in: /Users/rion/dev/flink/target/rat.txt -> [Help 1]

I'm sure it's a trivial fix. I'll try to carve out some time to build and explore the updated documentation with these changes and approve if all looks good!

@MartijnVisser
Copy link
Contributor Author

@flinkbot run azure

@rionmonster
Copy link
Contributor

I'm not sure if it's a local development issue specifically, but it appears that none of the images are rendering properly. I suspect it's potentially a directory-shift that occurred during the updates?

Screenshot 2026-02-05 at 11 46 22 PM

@github-actions github-actions bot added the community-reviewed PR has been reviewed by the community. label Feb 6, 2026
This avoids now breaking all references that are incoming from externalized connectors. This should be fixed after completing the restructuring, removing these stub pages
…nfiguration

Replace {{.Site.BaseURL}}/path pattern with Hugo's relURL function for static assets (CSS, JS, images). The previous pattern created malformed URLs when baseURL had a trailing slash.
The tab switching functionality used setAttribute("checked") which only modifies the HTML attribute, not the DOM property. CSS :checked selectors rely on the DOM property, causing synchronized tabs to show no content.

Changed to set input.checked property directly, which the CSS properly detects.
@MartijnVisser MartijnVisser force-pushed the refactor-documentation branch from 5579697 to a91b832 Compare February 6, 2026 11:48
@MartijnVisser
Copy link
Contributor Author

I'm not sure if it's a local development issue specifically, but it appears that none of the images are rendering properly. I suspect it's potentially a directory-shift that occurred during the updates?

Yeah this is a local development problem specifically, it happened for all images. The image shortcode didn't properly work with baseURL for local builds. That should be fixed now, thanks for flagging!

@rionmonster
Copy link
Contributor

Yeah this is a local development problem specifically, it happened for all images. The image shortcode didn't properly work with baseURL for local builds. That should be fixed now, thanks for flagging!

Thanks for the clarification @MartijnVisser, I figured as much. Just confirmed that the latest commits addressed the previous RAT-related licensing issues (and Azure seems to agree). Approving — thanks again!

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.

3 participants