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

Intelligent Search Scopes #15

Open
2 tasks
ES-Alexander opened this issue Nov 18, 2021 · 1 comment
Open
2 tasks

Intelligent Search Scopes #15

ES-Alexander opened this issue Nov 18, 2021 · 1 comment
Assignees
Labels
enhancement New feature or request infrastructure Structure rather than content

Comments

@ES-Alexander
Copy link
Collaborator

Important for #1

  • Ideally should have multiple search 'modes'/scopes:
  1. full docs search
    • search the whole website, including across all versions of each software
    • preferable if the search index can be preferentially searched with later versions of software first
    • somehow need to avoid the same page coming up different times from multiple versions (possibly have a custom index for this search mode which just includes the latest version of each page name??)
  2. search the docs of a specified version of a software (e.g. search only the QGC 4.1.4 docs)
    • can hopefully use just a subset of the default full index, branched out from just the relevant version folder of the specified software (not sure if that's how search indexes work, so may be required to create separate indexes for each version of each software)
  3. [optional] search multiple versions of a specific software
    • could be all versions (likely easiest), or could be a (filtered?) subset (e.g. companion-1.0.*)
    • if we only want to support all, this is basically the same as 2. but from the parent/section folder of that software (if it's possible to search just a branch of an index then this is basically free, and would just need to be enabled)
    • kind of has the same issue as 1. for several (possibly identical) versions of the same page, but likely harder to deal with (maybe that's just a cost of using this mode)
  • If modes are available, need the UI to use them (may need input/help from @rafaellehmkuhl)
    • we're thinking something like GitHub's search bar, which allows easily selecting which scope to use
      github-search-example
@ES-Alexander ES-Alexander added the enhancement New feature or request label Nov 18, 2021
@ES-Alexander ES-Alexander added the infrastructure Structure rather than content label May 12, 2022
@ES-Alexander
Copy link
Collaborator Author

Possibly change search provider to Algolia or something.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request infrastructure Structure rather than content
Projects
None yet
Development

No branches or pull requests

2 participants