[GitHub] [pulsar] momo-jun commented on issue #17688: [Doc] Broken links in `io-connectors` page for versions prior to 2.5.2

[GitBox <gi...@apache.org>]

momo-jun commented on issue #17688:
URL: https://github.com/apache/pulsar/issues/17688#issuecomment-1253409806

   @tisonkun I don't have answers to this question. @Anonymitaet @urfreespace any thoughts?
   > @momo-jun now I know the issue you reported is about low quality of old version documents. There are hard links to the "latest" pages which have been changed over time, or the content is itself incorrect.
   > 
   > For example, one of the broken links you mentioned for 2.3.1 has never been correct since it was created #4040 - a link from `io-connectors.md` to `io-aerospike.md` but the latter is missing. (So...how can it be present on https://pulsar.staged.apache.org/docs/en/2.3.1/io-aerospike/?)
   
   ----
   Discussed with @urfreespace, that redirecting the historical versions of docs to the archived/staged site has potential risks:
   * it's just a snapshot without any maintenance possibilities.
   * it also provides 2.8.x/2.9.x/2.10.x docs in the old website framework which will confuse users.
   ---- 
   
   To sum up:
   1. We do need to evaluate changes that impact links in historical versions of docs to avoid 404 issues. 
   2. The general strategy is that we do not maintain historical versions of docs that are out of the maintenance cycle. 
   ---- We've added a disclaimer on all those versions that says - these docs are no longer actively maintained.
   3. We need a principle about the necessity of fixes in those historical versions of docs - We apply a hotfix only `if it has a wide range of impact on the accessibility and can be fixed with automated solutions`.
   ---- I submitted #17763 to fix all the broken links in those historical versions of docs. Thank @urfreespace for providing the hotfix solution.
   
   @D-2-Ed @tisonkun @Anonymitaet feel free to share any thoughts or comments.
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org