Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only Index Docs from Currently Supported Versions #17898

Closed
dave2wave opened this issue May 18, 2022 · 9 comments
Closed

Only Index Docs from Currently Supported Versions #17898

dave2wave opened this issue May 18, 2022 · 9 comments
Assignees
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.

Comments

@dave2wave
Copy link
Member

In Algolia there is a crawler configuration which skips "incubating" docs. I think that we should stop creating an index for versions of pulsar components which are no longer supporting.

(1) We can either remove these pages from the site.

or more likely

(2) Include those versions in the exclude pattern.

@michaeljmarshall
Copy link
Member

(2) Include those versions in the exclude pattern.

I support this option--I assume that some users are still running outdated versions of Pulsar, and they would benefit from the docs being online.

@tisonkun
Copy link
Member

I agree. And leave the docs of old versions as is.

I talked with @momo-jun today concluding a similar result. Coming up with a proposal in weeks.

@Anonymitaet Anonymitaet transferred this issue from apache/pulsar-site Sep 30, 2022
@Anonymitaet Anonymitaet added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. website labels Sep 30, 2022
@github-actions
Copy link

The issue had no activity for 30 days, mark with Stale label.

@github-actions github-actions bot added the Stale label Oct 30, 2022
@tisonkun
Copy link
Member

tisonkun commented Dec 5, 2022

FYI @urfreespace

@github-actions github-actions bot removed the Stale label Dec 6, 2022
@tisonkun
Copy link
Member

Closed as done. The incubating pages are removed from the page.

About other unmaintained docs pages, we may later come up with another proposal.

@dave2wave How does Algolia works to exclude those unmaintained docs? I need some technical income to find a way to continue this cleanup work.

@tisonkun
Copy link
Member

I notice that the version config contains a option noIndex https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#VersionsConfig to hint the search engine index those version, will investigate.

@tisonkun tisonkun self-assigned this Jan 13, 2023
@tisonkun tisonkun reopened this Jan 13, 2023
@tisonkun
Copy link
Member

tisonkun commented Apr 24, 2023

Delivered noIndex config at apache/pulsar-site#506. But I'm not sure if Algolia omit ancient versions now or we should still make more configs.

@tisonkun
Copy link
Member

Closed as somehow we now have only indices for new versions. I'm not sure why but let's open a new issue if there is any regressions.

image

@tisonkun
Copy link
Member

Maybe the noIndex metadata helps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

No branches or pull requests

4 participants