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

Algolia docs #1082

Merged
merged 4 commits into from
Sep 19, 2023
Merged

Algolia docs #1082

merged 4 commits into from
Sep 19, 2023

Conversation

LeaveMyYard
Copy link
Contributor

Reworked docs search to use Algolia search

docs/crawler.js Outdated
pageRank: (() => {
if (url.pathname.includes("/installation/index.html")) {
return 10;
} else if (url.pathname.includes("/triggers/kubernetes.html")) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

@LeaveMyYard we need to prioritize all trigger and action pages, not just /triggers/kubernetes.html and /actions/event-enrichment.html

Copy link
Collaborator

@aantn aantn left a comment

Choose a reason for hiding this comment

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

Approving with comments. This is already an improvement over existing search so I am merging despite the comments. Please open a follow up PR fixing comments.

@@ -0,0 +1,112 @@
// This is the code example for the crawler configuration file for https://crawler.algolia.com/
Copy link
Collaborator

Choose a reason for hiding this comment

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

How is this file used? It doesn't seem to be included anywhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So the code is used at https://crawler.algolia.com
Because it defines on how a crawler indexes the docs and how the search after that is working - I descided to leave a reference in our codebase to not to loose it in the future

Copy link
Collaborator

Choose a reason for hiding this comment

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

Good thinking, can you add a comment to the file making that explicit. (This file needs to be copied to crawler.algolia.com to work - its stored here as reference...)

<!-- Search interface -->
{% include "partials/search.html" %}
{% endif %}
<!-- Algolia search -->
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would it be possible to make the fonts in the search results much larger? It's a bit hard for me to read. (I know we said not to worry about design, but I've changed my mind on this one aspect.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we can make it even the same as it was before, but we will need to update our CSS files
If you want - I can do that, but it will take some time
Or also yes, I can increate just the text size also

@@ -0,0 +1,112 @@
// This is the code example for the crawler configuration file for https://crawler.algolia.com/
new Crawler({
Copy link
Collaborator

Choose a reason for hiding this comment

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

See if you can strip out the sign at the end of search results. If necessary, contact Algolia.

@aantn aantn merged commit e789e01 into master Sep 19, 2023
14 checks passed
@aantn aantn deleted the algolia-docs branch September 19, 2023 03:17
@aantn
Copy link
Collaborator

aantn commented Sep 19, 2023

@pavangudiwada FYI

pavangudiwada pushed a commit to pavangudiwada/robusta that referenced this pull request Nov 6, 2023
* Switch search to Algolia doc search
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

Successfully merging this pull request may close these issues.

2 participants