davidzollo opened a new pull request, #11058:
URL: https://github.com/apache/seatunnel/pull/11058
### Purpose of this pull request
This pull request improves the getting started path in the SeaTunnel docs by:
- adding a new homepage entry card for `Run your first job`
- adding a short local first-run guide under `Getting Started -> Locally`
- adding 6 practical recipe pages under `Getting Started -> Recipes`
- linking the new entry and recipes from the current getting started flow in
both English and Chinese docs
### Does this PR introduce _any_ user-facing change?
Yes.
Users will now see:
- a new entry card on the About page that sends first-time users to `Run
your first job`
- a new `Locally` landing path that includes `Run your first job`
- a new `Recipes` section with these scenario guides:
- MySQL CDC -> Doris
- JDBC -> S3
- Kafka -> Iceberg
- Http -> JDBC
- File -> StarRocks
- Multi-table CDC
Each recipe includes prerequisites, minimal configuration, validation
result, and common pitfalls.
### How was this patch tested?
Formatting:
- `./mvnw spotless:apply`
Repository verification:
- `./mvnw -q -DskipTests verify`
- This failed in the local environment at `seatunnel-dist`
`export-connector-metadata` with classpath/runtime metadata export noise
unrelated to the docs changes.
- `./mvnw -q -DskipTests -pl '!seatunnel-dist' verify`
- Passed.
- This was used as the final repository-level verification for this
docs-only change.
Website build and UI verification:
- Copied the local `seatunnel-website` workspace into a preview directory
and synced the current PR docs into that preview using the same directory
mapping and image-path rewrite logic used by the website sync flow.
- `npm install`
- `npm run build`
- `npm run serve -- --host 127.0.0.1 --port 3100`
- Verified these pages in a browser against the local preview:
- `/docs/introduction/about`
- `/docs/getting-started/locally/run-your-first-job`
- `/docs/getting-started/recipes/mysql-cdc-to-doris`
- `/zh-CN/docs/introduction/about`
- `/zh-CN/docs/getting-started/recipes/mysql-cdc-to-doris`
Verification focus:
- homepage entry card renders and links correctly
- `Getting Started` sidebar shows the new `Locally` entry and `Recipes`
category
- recipe pages render with the required sections
Reused artifacts / scope notes:
- Reused a copied local `seatunnel-website` workspace as the preview base.
- No backend runtime artifacts were reused for behavior validation because
this PR is documentation-only.
- No Java unit or integration tests were added because no production code
changed.
- This run did not revalidate connector runtime behavior itself; it
revalidated documentation structure, rendering, navigation, and page content.
### Check list
* [ ] If any new Jar binary package adding in your PR, please add License
Notice according
[New License
Guide](https://github.com/apache/seatunnel/blob/dev/docs/en/developer/new-license.md)
* [x] If necessary, please update the documentation to describe the new
feature. https://github.com/apache/seatunnel/tree/dev/docs
* [ ] If necessary, please update `incompatible-changes.md` to describe the
incompatibility caused by this PR.
* [ ] If you are contributing the connector code, please check that the
following files are updated:
1. Update
[plugin-mapping.properties](https://github.com/apache/seatunnel/blob/dev/plugin-mapping.properties)
and add new connector information in it
2. Update the pom file of
[seatunnel-dist](https://github.com/apache/seatunnel/blob/dev/seatunnel-dist/pom.xml)
3. Add ci label in
[label-scope-conf](https://github.com/apache/seatunnel/blob/dev/.github/workflows/labeler/label-scope-conf.yml)
4. Add e2e testcase in
[seatunnel-e2e](https://github.com/apache/seatunnel/tree/dev/seatunnel-e2e/seatunnel-connector-v2-e2e/)
5. Update connector
[plugin_config](https://github.com/apache/seatunnel/blob/dev/config/plugin_config)
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
