Skip to content

Conversation

neshkeev
Copy link
Contributor

I noticed that the images in the documentation are not rendered properly, so I fixed the paths in the images links.

I tested if the images are rendered correctly locally with the following command, please tell me if the command is not correct:

asciidoctor -b html5 -R doc/modules/cassandra/pages/ doc/modules/cassandra/pages/developing/data-modeling/*.adoc

Signed-off-by: Nikita Eshkeev <kastolom@gmail.com>
@neshkeev
Copy link
Contributor Author

Could anyone, please, take a look at the PR? It would be great if the documentation could properly render the images

multiplicity of the connection.

image::data_modeling_hotel_erd.png[image]
image::images/data_modeling_hotel_erd.png[image]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when I view this file in IDEA, image::data_modeling_hotel_erd.png[image] just displays the image correctly.

Same here https://cassandra.apache.org/doc/trunk/cassandra/developing/data-modeling/data-modeling_conceptual.html

Why should we rework this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed images/, then I generated HTML once again, but no pictures got rendered on the pages. So I believe images/ cannot be omitted, apparently IDEA uses some alternative way to render pictures

I used the asciidoctor command from the first message, please tell me if this project executes a different command to generate documentation

logical data model.

image::cassandra:developing/data-modeling/data_modeling_chebotko_logical.png[image]
image::images/data_modeling_chebotko_logical.png[image]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is broken in IDEA when viewing there, this displays it:

image::data_modeling_chebotko_logical.png[image]

Same approach as above. We do not need images/

@smiklosovic
Copy link
Contributor

smiklosovic commented Sep 23, 2025

I will be covering more documentation issues closer to the release we are so please don't feel to be overlooked when there is not any activity on this so far. I am just tagging everything with "docs" label to see them all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants