Hey everyone,

As part of the docs modernization work (CASSANDRA-21314), we've been burning
down the broken links that are blocking the Antora 3 upgrade
(CASSANDRA-21315). The bulk of that landed under CASSANDRA-21342 and is now
fixed across all release branches. What's left is a small pile of links
where the fix is a content decision, not a retarget. I summarized it in
CASSANDRA-21449, and one of them is worth a quick discussion here because
it changes site navigation.

The website nav and front page both link to a bugs.adoc page that doesn't
exist and, as far as git history shows, never has. Under Antora 2, it just
renders as a dead link, but Antora 3 with strict error checking will fail
the build on it, so we have to do something.

To see it, go to https://cassandra.apache.org/doc/latest/index.html and try
to click on "How to report bugs"

Three options:
1. Create a short "Reporting bugs" page — how to file a JIRA, what info to
include, where to ask first if you're not sure it's a bug.
2. Replace the nav entry with a direct external link to the Cassandra
JIRA project.
3. Drop the entry entirely, the community page already covers how to reach
us.

My vote is option 1. A small page costs us almost nothing to maintain and
gives us a place to say "check the user list or #cassandra first," which
probably saves a few duplicate JIRAs a year. I can create it.

The rest of the 21449 items are in-tree doc links (example tables that were
never written, a couple of pages that don't exist yet) and I'll just
document those decisions on the ticket. Speak up there if you care about
any of them.

If there are no objections within a few days, I'll proceed with the new
page and open a PR.

Thanks,

Patrick

Reply via email to