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

Index Erlang/OTP apps into typesense #48

Open
josevalim opened this issue Dec 13, 2024 · 2 comments
Open

Index Erlang/OTP apps into typesense #48

josevalim opened this issue Dec 13, 2024 · 2 comments

Comments

@josevalim
Copy link
Member

We can probably ask them to notify us on new tags/releases if necessary.

@josevalim josevalim changed the title Index Erlang/OTP packages into typesense Index Erlang/OTP apps into typesense Dec 13, 2024
@josevalim
Copy link
Member Author

@garazdawi do you have a preference of the version granularity you want us to index into search? Do you want every MAJOR.MINOR? Or also MAJOR.MINOR.PATCH?

@josevalim josevalim mentioned this issue Dec 13, 2024
6 tasks
@garazdawi
Copy link

We can probably ask them to notify us on new tags/releases if necessary.

Yes, no problem.

do you have a preference of the version granularity you want us to index into search? Do you want every MAJOR.MINOR? Or also MAJOR.MINOR.PATCH?

The docs we publish are only for the latest patch release on each branch + the master branch, at the moment OTP-28.0-rc0, OTP-27.2, OTP-26.2.5.6, OTP-25.3.2.16, etc.

So I want the indexing for each patch release, but I don't care about the results for anything but the latest patch on each branch. We may want to have indexing for each patch in the future, but I doubt it.

If you are crawling erlang.org for the data, what you want to crawl is currently:

  • erlang.org/doc/ ## This is 27
  • erlang.org/docs/28

and then when 28 is released it will be:

  • erlang.org/docs/27
  • erlang.org/doc/ ## This is 28
  • erlang.org/docs/29

erlang.org/docs/27 also exists now for consistency, but it should not be used.

With algolia we currently use sitemap.xml to describe which files to crawl. We also insert this metadata into the docs to help with crawling:

<meta name="major-vsn" content="27">
<link rel="canonical" href="https://www.erlang.org/doc/system/installation_guide.html" />

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants