absurdfarce commented on PR #2055: URL: https://github.com/apache/cassandra-java-driver/pull/2055#issuecomment-3286741878
So the docs as written right now use absolute URLs for a lot of the Javadoc references, in part to enable a sort of split publishing: Javadocs can live in one place (in DataStax documentation historically) while the Markdown can get processed and published somewhere else. As just one example of what I'm talking about consider [this section](https://github.com/apache/cassandra-java-driver/blob/4.19.0/manual/core/README.md?plain=1#L197) of core/README.md with links defined [here](https://github.com/apache/cassandra-java-driver/blob/4.19.0/manual/core/README.md?plain=1#L337-L350). We had discussed a three-fold conversion of docs in total: * Generate new content to publish in GH branch (this PR) * Create PR for process to do generation + publish * Update links in the current documentation to point to the proper place What I'm discussing here could be put off until we work on the third PR above. That's not a _huge_ deal; we'd temporarily be pointing ASF users to the Javadoc for 4.17.0 hosted on the DataStax site but that would be addressed when the third PR is merged and we re-deploy. I guess my question is... do we want to continue with this process of using absolute URLs to refer to Javadoc? We probably _can_ switch over to something relative now, right? There are pluses and minuses to consider there... but it seemed worthwhile to ask the question. -- 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]
