pjfanning opened a new pull request, #666:
URL: https://github.com/apache/pekko-connectors-kafka/pull/666
### Motivation
The docs linked to the Kafka 3.7 site. The Kafka website has been rebuilt so
`documentation.html` is now a JavaScript redirect page for every version
(including `/37/`), and the `#section` anchors used in our docs no longer exist
there. The link validator doesn't catch this because the pages still return 200.
### Modification
- Set `KafkaVersionForDocs` to `43` to match the `kafka-clients` 4.3.1
dependency.
- Repoint `@extref` links to the new doc pages:
- `documentation.html#security` → `security/`
- `#security_configclients` →
`security/encryption-and-authentication-using-ssl/#configuring-kafka-clients`
- `#security_sasl_kerberos_clientconfig` →
`security/authentication-using-sasl/#configuring-kafka-clients`
- `#consumerconfigs` → `configuration/consumer-configs/`
- `documentation#index` → `getting-started/introduction/`
- Use a direct javadoc path for `KafkaConsumer` in `home.md`.
- In `consumer.md`, make the consumer assignment strategy link an `@extref`
to `configuration/consumer-configs/#partition.assignment.strategy`, and point
the Kafka 3.0 notes at `39/getting-started/upgrade/#notable-changes-in-300`
(the 4.3 upgrade page no longer covers 3.0).
### Result
Kafka doc links go to the 4.3 docs and land on sections that exist.
### Tests
- `sbt docs/paradox unidoc`: success
- `cs launch net.runne::site-link-validator:0.2.5 --
scripts/link-validator.conf`: exit 0, no kafka.apache.org issues
- curl of every kafka.apache.org URL in the generated site: all 24 return
200, and all 4 anchors exist on their target pages
### References
None - Kafka website restructure broke doc anchors
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
