incubator-devlake icon indicating copy to clipboard operation
incubator-devlake copied to clipboard

There is no way to search our docs at https://devlake.apache.org/docs

Open joncodo opened this issue 2 years ago • 5 comments

Documentation Scope

So I am looking for new documentation to add but I want to make sure that the topics are not already covered in our docs. It seems like the only way to do this now is to go to each page individually and search through chrome's search feature.

Describe the Change

I would like to see us enable search on our apache docs site. I am not sure how we do this now but I will work to figure it out. I think will really improve the usability of our docs.

Screenshots

Screen Shot 2022-06-06 at 12 44 37 PM

joncodo avatar Jun 06 '22 15:06 joncodo

I think this would be applicable to solve this problem: https://docusaurus.io/docs/search#using-algolia-docsearch

The service is free for any open-source project: just make sure to read the checklist and apply to the DocSearch program.

DocSearch crawls your website once a week (the schedule is configurable from the web interface) and aggregates all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API.

joncodo avatar Jun 06 '22 15:06 joncodo

It would also be nice to be able to search docs and github issues together.

joncodo avatar Jun 08 '22 12:06 joncodo

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] avatar Jul 09 '22 00:07 github-actions[bot]

I'll work on this.

yumengwang03 avatar Jul 11 '22 02:07 yumengwang03

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] avatar Aug 11 '22 00:08 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] avatar Sep 14 '22 00:09 github-actions[bot]

This issue has been closed because it has not received response for too long time. You could reopen it if you encountered similar problems in the future.

github-actions[bot] avatar Sep 21 '22 00:09 github-actions[bot]