nicusX opened a new pull request, #25181:
URL: https://github.com/apache/flink/pull/25181
## What is the purpose of the change
* Improving the contributors' experience when modifying docs of an existing
connector or developing docs of a new connector.
## Brief change log
* Add a function to `docs/setup_docs.sh` script that can be used to import a
fork of a connector repo
* Add instructions to `docs/README.md` about generating docs locally to
preview your connector's docs contribution
TL;DR
To generate the docs site locally including the docs of the connector you
are working on (while your changes are still in a fork, and not yet merged into
the main connector repo) you need to edit the `setup_docs.sh` pointing to your
form, and then you can generate the site.
I added a function in `setup_docs.sh` that you can use for this. The
original `integrate_connector_docs` function only works with merged connectors.
I preferred not to touch it.
## Verifying this change
The change can be verified generating the docs site, locally, following the
new additional instructions in `docs/README.md`:
1. Have Hugo installed
2. Have a fork of a connector repo
3. Push any docs change to a branch/tag
4. Modify `docs/setup_docs.sh` replacing the existing
`integrate_connector_docs ...` with `integrate_connector_fork_docs <fork-owner>
<connector-name> <branch-name>` (e.g. `integrate_connector_fork_docs nicusX
prometheus FLINK-33137-docs`)
5. Run `setup_docs.sh` and then `build_docs.sh` normally
6. Verify the changes in your fork are visible
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): No
- The public API, i.e., is any changed class annotated with
`@Public(Evolving)`: No
- The serializers: No
- The runtime per-record code paths (performance sensitive): No
- Anything that affects deployment or recovery: JobManager (and its
components), Checkpointing, Kubernetes/Yarn, ZooKeeper: No
- The S3 file system connector: No
## Documentation
- Does this pull request introduce a new feature? No
- If yes, how is the feature documented? not applicable
--
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: issues-unsubscr...@flink.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
