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

Integrate SearchUI with DocGenerator #1681

Closed
Tracked by #1600
palaciosjeremias opened this issue Aug 3, 2021 · 1 comment · Fixed by #1691
Closed
Tracked by #1600

Integrate SearchUI with DocGenerator #1681

palaciosjeremias opened this issue Aug 3, 2021 · 1 comment · Fixed by #1691
Assignees
Labels
docs Add or improve documentation

Comments

@palaciosjeremias
Copy link
Contributor

As part of the Epic 1600, we are using SearchUI as the main tool to index, filter, and display the documentation content of Wazuh QA.
The input for SearchUI will be created in the Epic 1536.
Based on the PoC created for 1666 we have to create integrate this development with the existent DocGenerator tool.
This integration should be made with a python script capable to:

  • Be imported by DocGenerator for execution.
  • Use Config module to know the output folder where the jsons to be indexed will be.
  • Ingest all the jsons from the output folder recursively.
  • Re-index and re-lunch SearchUI locally every time DocGenerator runs it.
@MiguelazoDS
Copy link
Member

MiguelazoDS commented Aug 4, 2021

While going to this development some changes need to be implemented:

  • Currently, the index is hardcoded in the Search.js script. We need to parameterize that value.
  • Seach box is not working. 07262e1
  • Parse JSON objects to show information.
  • The module in charge to index should check if files exist.

Search box working

image

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

Successfully merging a pull request may close this issue.

2 participants