[improve][doc] Specially handle Python and C++ API documents - #18477
Merged
Conversation
tisonkun
requested review from
Anonymitaet,
michaeljmarshall,
momo-jun and
urfreespace
November 15, 2022 10:40
github-actions
Bot
added
the
doc
Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
merlimat
approved these changes
Nov 15, 2022
Member
Author
|
Verified the replace logics locally. Merging... |
momo-jun
reviewed
Nov 16, 2022
| | Language | Documentation | Release note | Code repo | | ||
| | --------- |------------------------------------------------------------------------| --------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | ||
| | Java | [User doc](client-libraries-java.md) <br/> [API doc](/api/client/) | [Bundled](/release-notes/) | [Bundled](https://github.com/apache/pulsar/tree/master/pulsar-client) | | ||
| | C++ | [User doc](client-libraries-cpp.md) <br/> [API doc](/api/cpp/3.0.0) | [Bundled](/release-notes/) | [Standalone](https://github.com/apache/pulsar/pulsar-client-cpp) | |
Contributor
There was a problem hiding this comment.
@Tison may I know why the latest version number is hard-coded here for C++ API docs while @pulsar:apidoc:cpp@ is used in other occurrences?
Member
Author
There was a problem hiding this comment.
See the description at apache/pulsar-site#291.
Now they have their own repository and release cycle, it's impossible to infer the proper version from the current Pulsar version. We should instead hardcode the corresponding versions for new versions.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is the counterpart of apache/pulsar-site#291.
Now they have their own repository and release cycle, it's impossible to infer the proper version from the current Pulsar version. We should instead hardcode the corresponding versions for new versions.
Documentation
docdoc-requireddoc-not-neededdoc-completeMatching PR in forked repository
PR in forked repository: