question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

ensure algolia indexes the content of the snippets

See original GitHub issue

it looks like algolia is only indexing the text in our documentation. for example. if I’m interested in learning what the schema of the meta section is, I might look up “meta”, but this doesn’t take me to the schema docs. this was discovered by a user. here’s more of his feedback:

Yes, I searched and read results for
DAGSpec
meta

and additionally reviewed

https://docs.ploomber.io/en/latest/user-guide/parametrized.html https://docs.ploomber.io/en/latest/user-guide/configuration.html

Issue Analytics

  • State:closed
  • Created a year ago
  • Comments:8 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
edublancascommented, Jul 13, 2022

so we want the snippets to be searchable. a snippet is anything that looks like a terminal or text editor. for example, if I look up:

path: path/to/sources

this should show up: https://docs.ploomber.io/en/latest/api/spec.html#meta

since the path: path/to/sources appears in a snippet in that section

0reactions
edublancascommented, Jul 15, 2022

great! I tested it, and it works fine. Can you document the steps you followed? Add a section here and briefly describe how you managed to get this working.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to optimize search indexing for top performance - Algolia
Best practices for fast indexing performance (with code snippets) · 1 – Batch indexing instead of updating one record at a time ·...
Read more >
Indexing | Rails - Algolia
In the following snippets, we'll delete all contacts in the Algolia index and create 10,000 contacts. The first snippet dispatches an indexing ......
Read more >
Preparing your data for indexing - Algolia
Learn how to prepare your data for Algolia, how to fetch it from your data source, and how to format and structure your...
Read more >
Highlighting in InstantSearch.js - Algolia
Algolia removes all HTML tags from the snippeted results to ensure the text displays correctly within pre-highlighting and post-highlighting ...
Read more >
Implementing Rules - Algolia
Go to the Rules tab for a selected index and click on Add Rule. ... building (and deleting) Rules based on the content...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found