We have a problem in a lot of blog posts that they link into the Antora 
generated docs.

Many link to the “next” version of the docs which has two problems:

- as release announcements,  they should link to the doc version that’s been 
released.
- there’s no reason to suppose any particular page in ‘next’ is going to stay 
there.

From this point of view we should change all the release announcement links to 
point to the docs in the released version. That’s an improvement, but it will 
cause another problem:

- At the moment our plan is to drop the docs for no-longer-supported versions 
when they aren’t used by supported versions of other subprojects.

So, eventually all the links to docs in blog posts will break.

I think we should:

- change all blog post links to point to explicit appropriate doc versions.  
I’m somewhat afraid about how big a job this will be, but the current links to 
“next” are clearly wrong in all cases.

- Decide what to do about old versions.  I can think of three possibilities:

— Keep all the old docs versions in the docs, perhaps marking them 
“unsupported”.  There might be ways to do this without building those portions 
of the website every time but this would take some time and thought and 
wouldn’t be my highest priority for some time.
— Delink broken links in the blog, marking them something “no longer 
documented” or “obsolete” or something.
— Remove the blog posts about no-longer-documented versions.

I really don’t know what to do here, so I’m hoping discussion will result in a 
“best path forward”.

This problem has been appearing with some regularity, and appeared today with 
camel-quarkus.  I propose https://github.com/apache/camel-website/pull/778 
<https://github.com/apache/camel-website/pull/778> to fix todays problem, which 
follows none of these ideas and is not very satisfactory, but allows the site 
to build.

David Jencks

Reply via email to