Skip to content

[fix][doc] Fix broken links in legacy docs#435

Merged
Anonymitaet merged 16 commits intoapache:mainfrom
momo-jun:fix-broken-links-in-legacy-docs
Feb 28, 2023
Merged

[fix][doc] Fix broken links in legacy docs#435
Anonymitaet merged 16 commits intoapache:mainfrom
momo-jun:fix-broken-links-in-legacy-docs

Conversation

@momo-jun
Copy link
Contributor

@momo-jun momo-jun commented Feb 24, 2023

Motivation

Following #406, this PR aims to clean up the existing 404 issues in Pulsar legacy docs before 2.8.0.

Modifications

The major reasons for broken links in the legacy doc sets and related modifications in this PR are:

  • the linked file is missing for unknown reasons - the files are added back using the nearest doc version.
  • the linked file is invalid because the feature is unsupported in those earlier versions - these links are removed.
    I think some files have been overwritten by later versions unexpectly, for example, the doc version 2.2.0, 2.3.0 and 2.3.2 include content of TableView, which was introduced in 2.10.0.
  • the linked file is in invalid format - these links are fixed.

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

@github-actions github-actions bot added the doc Improvements or additions to documentation label Feb 24, 2023
@momo-jun momo-jun self-assigned this Feb 24, 2023
@momo-jun momo-jun marked this pull request as ready for review February 27, 2023 14:29
@@ -0,0 +1,40 @@
---
id: helm-install
Copy link
Member

Choose a reason for hiding this comment

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

Some features were added to earlier versions. Have you double checked this with engineers?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As mentioned in the PR description, I do think the doc sets for 2.2.0, 2.3.0 and 2.3.2 (and maybe more) have been overwritten by later versions unexpectedly during the website upgrade in last May and include many newly added features, e.g., TableView (introduced in 2.10.0) - I've removed the TableView related content though, but I believe there are much more, and challenging to check and clean one by one this way.

It would be more effective if there is a way to directly trace back the specific original doc versions; otherwise, those three doc sets have a huge gap in aligning with features. It's another thread, though. I discussed this with @urfreespace but the answer was negative.

So this PR aims to clean up 404 issues only. Despite this, I've checked with engineers about the availability of several features, e.g., schema, pulsar manager, security, etc.

@Anonymitaet Anonymitaet merged commit 6cac4f0 into apache:main Feb 28, 2023
@Anonymitaet Anonymitaet added this to the 3.0.0 milestone Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments