Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Create a dropdown version list for API document #120

Open
tisonkun opened this issue Nov 16, 2022 · 4 comments
Open

[DOC] Create a dropdown version list for API document #120

tisonkun opened this issue Nov 16, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@tisonkun
Copy link
Member

After a discussion with @momo-jun, I'm trying to add a version dropdown list in the C++ API documents so that we can always link to the latest version.

References:

Originally posted by @tisonkun in apache/pulsar#18485 (comment)

@tisonkun
Copy link
Member Author

I don't have time to promise working on this issue recently so any help is welcome.

@tisonkun tisonkun added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Nov 16, 2022
@tisonkun
Copy link
Member Author

An alternative is that we can add a new https://pulsar.apache.org/api/cpp/ page, which serves as a version selector. We direct new links to there and users can select the version to browser.

In this way, we can avoid hacking into Doxygen build process.

@tisonkun
Copy link
Member Author

tisonkun commented Nov 16, 2022

Another alternative is that we add a new placeholder said @pulsar:cpp:version@ to be resolved to the latest release version and always link to the latest version of C++ client.

As long as the following versions are backward compatible, this solution should be viable.

@momo-jun
Copy link
Contributor

@BewareMyPower @Anonymitaet FYI - This issue might be relevant to the CPP release discussed on the call. It aims to avoid manual maintenance of docs in terms of the version numbers in the API doc links, since CPP client has had separate releases and version numbers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants