search

scylladb / cpp-driver

Scylla C/C++ Driver
25 stars 25 forks source link

Broken documentation links #66

Closed hopugop closed 2 years ago

hopugop commented 2 years ago

Links from this page are broken: https://cpp-driver.docs.scylladb.com/master/topics/index.html

Example: cass_cluster_set_num_threads_io() shortcut points to a 404'd page: https://cpp-driver.docs.scylladb.com/master/api/struct.CassCluster/#function-cass_cluster_set_num_threads_io There are many more on that page.

cc @annastuchlik

annastuchlik commented 2 years ago

@hopugop Thanks for reporting this problem!

@dgarcia360 None of the links to our API is working in the cpp-driver documentation. I THINK I know how to fix it, but I need you to confirm because I'm not sure how the linking mechanism works in this project.

The links are configured to refer the user to the datastax API, for example:

See https://raw.githubusercontent.com/scylladb/cpp-driver/master/topics/README.md.

But on the published page they look like links to the ScyallaDB API: image

When you click the link, you get 404.

Solution: Replace datastax.github.io/cpp-driver with cpp-driver.docs.scylladb.com/master in the URLs, for example: