You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by "Michael Semb Wever (Jira)" <ji...@apache.org> on 2025/10/09 06:53:00 UTC
[jira] [Comment Edited] (CASSANDRA-20960) Add local script for checking project documentation.
[ https://issues.apache.org/jira/browse/CASSANDRA-20960?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18028537#comment-18028537 ]
Michael Semb Wever edited comment on CASSANDRA-20960 at 10/9/25 6:52 AM:
-------------------------------------------------------------------------
Docs today are built (and tested) like:
```
cd cassandra-website
/run.sh website build -g -u cassandra:https://github.com/thelastpickle/cassandra.git -b cassandra:mck/20678/5.0
```
That approach means you have to have pushed your dev branch first, as the cassandra-website build process takes parameters for the fork+branch of in-tree docs you want to build but uses like inside a docker build, as you have also done.
The ticket you need here is CASSANDRA-17260 that would make it possible to build just the in-tree docs.
The idea is that in-tree needs its own site.yml and the how in-tree was built would not be different to how cassandra-website builds it. See (site.template.yaml)[https://github.com/apache/cassandra-website/blob/trunk/site-content/site.template.yaml]
and (site_yaml_generator.py)[https://github.com/apache/cassandra-website/blob/trunk/site-content/bin/site_yaml_generator.py].
Currently the site.yml is generated on-the-fly by the cassandra-website build, after having copied in all the in-tree cassandra versions. See `generate_site_yaml ` at https://github.com/apache/cassandra-website/blob/trunk/site-content/docker-entrypoint.sh#L175
Implementing CASSANDRA-17260 would remove the need of this script.
My only objection to temporarily having the script is if it still generates differences that don't get detected and published (because folk are only using the script to review and before merging).
was (Author: michaelsembwever):
Docs today are built (and tested) like:
```
cd cassandra-website
/run.sh website build -g -u cassandra:https://github.com/thelastpickle/cassandra.git -b cassandra:mck/20678/5.0
```
That approach means you have to have pushed your dev branch first, as the cassandra-website build process takes parameters for the fork+branch of in-tree docs you want to build but uses like inside a docker build, as you have also done.
The ticket you need here is CASSANDRA-17260 that would make it possible to build just the in-tree docs.
The idea is that in-tree needs its own site.yml
Currently the site.yml is generated on-the-fly by the cassandra-website build, after having copied in all the in-tree cassandra versions. See `generate_site_yaml ` at https://github.com/apache/cassandra-website/blob/trunk/site-content/docker-entrypoint.sh#L175
Implementing CASSANDRA-17260 would remove the need of this script.
My only objection to temporarily having the script is if it still generates differences that don't get detected and published (because folk are only using the script to review and before merging).
> Add local script for checking project documentation.
> ----------------------------------------------------
>
> Key: CASSANDRA-20960
> URL: https://issues.apache.org/jira/browse/CASSANDRA-20960
> Project: Apache Cassandra
> Issue Type: Improvement
> Components: Documentation
> Reporter: Jon Haddad
> Assignee: Jon Haddad
> Priority: Normal
>
> Add a simple script to evaluate if the anatora docs will build correctly. This is just to cut down on the overhead of doc contribution, not to replace the website build process.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org