lukas-vlcek
commented
5 months ago Regarding the item:
Improvements to the search engine on the openseach.org website.
I would really welcome if we can filter/restrict the search to specific topic/section only. For example I would like to be able to run searches only on top of OpenSearch server section (excluding Dashboards, Data Prepper, Clients and other sections).
And on top of that I would like to be able to focus searches on specific parts of the section, like the: "API reference only".
Shall I open a ticket in https://github.com/opensearch-project/project-website-search ?
hdhalter
Documentation strategy
Hello! Welcome to the proposed OpenSearch documentation strategy for what remains of 2024. Here are the key initiatives that are underway to help the OpenSearch community better understand and use OpenSearch. If you have additional ideas on where we should focus, please comment!
Close documentation gaps
Our main focus is to close the content gaps in our documentation, and we anticipate that we can close the gaps by end of Q3. We have known gaps in our REST APIs, aggregations, mappings, query DSL, and ingest processors content. If you know of other gaps, please let us know by creating an issue.
Support new development
We will support all new development on OpenSearch Project. The documentation team partners with developers to ensure all features for each new release have complete, accurate, and high quality documentation.
Address community feedback
An ongoing goal of ours is to maintain high quality content in the OpenSearch.org documentation website. This involves regularly collecting, analyzing, and addressing feedback that we receive from our community. We regularly monitor incoming suggestions from the feedback mechanism on the website, requests or conversations in Slack, questions in the community forums and other community engagements, and through GitHub. All incoming issues and PRs are triaged, and we ensure that all contributions follow the OpenSearch quality standards and guidelines.
We try to address feedback as we receive it, but we do have a large backlog. If you have expert knowledge in a particular area, feel free grab one or two suggestions to address. For more information, see Issues labeled = feedback.
Implement infrastructure improvements
Here are some infrastructure improvements we are planning to address in 2024, pending development support.
Documentation roadmap
This is the proposed roadmap for 2024. An “x” means we will work on and/or complete the task in the quarter. For the OpenSearch release schedule, see release schedule.
Recent improvements
So far in 2024, the OpenSearch documentation team made keys improvements, including:
Separated the component documentation
OpenSearch Project is comprised of several components, including OpenSearch (the core engine), OpenSearch Dashboards (data visualization), Data Prepper (data ingestion), and OpenSearch Benchmark (performance measurement). Since the documentation content is contained within one pipeline, all of the components appeared as if they fell under the same version. The components are split now. Future updates will include separate pipelines and version selector for each, as needed. See https://opensearch.org/docs/latest/.
Added a Getting Started section
Recent feedback revealed that the community had trouble knowing where to start with their OpenSearch journey, so we’ve added a new getting started section to help users get started. If you have any feedback, please submit feedback in the applicable page.
Improved the documentation-website repo
Additional resources
Call to action
Tell us what you think! Are we focused on the right things? Is anything missing? Should something be moved up in prioritization? Thank you for supporting OpenSearch.