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

[Meta] Restructure the TOC to make it easier for users to find content #1036

Closed
12 of 15 tasks
Tracked by #810
hdhalter opened this issue Aug 30, 2022 · 6 comments
Closed
12 of 15 tasks
Tracked by #810
Assignees
Labels
2 - In progress Issue/PR: The issue or PR is in progress. Usability
Milestone

Comments

@hdhalter
Copy link
Contributor

hdhalter commented Aug 30, 2022

As we grow our content, we need to have the right structure in place. This issue documents the planned updates to the TOC in the current structure. Further improvements will be made once we move to a new site design.

Here is a draft of the proposed updated navigation:

  • Getting Started with OpenSearch
    Introduction to OpenSearch
    Version History
    Breaking Changes

  • Installation and Configuration
    Installing OpenSearch (Tarball, Docker, Helm, RPM, Ansible Playbook)
    Installing OpenSearch Plugins
    Migrating/Upgrading to OpenSearch
    Configuring OpenSearch
    Installing and Configuring OpenSearch Dashboards (Tarball, Docker, Helm, RPM)
    Installing Dashboards Plugins

  • OpenSearch Dashboards
    Get Started
    Discover
    Dashboard
    Visualize
    Report and Share
    Alert and Detect
    Management

  • Security (About Security)
    Configuring Security
    Authentication
    Access Control
    Auditing

  • Index and Ingestion
    Index Templates
    Units and Data Types
    Indexing APIs
    Reindexing
    Index Aliases
    Data Streams
    Index Management
    Ingestion Nodes
    Segment Replication
    Field Types

  • Observability
    Event Analytics
    Operational Panels
    Piped Processing Language
    Notebooks
    Trace Analytics
    Log Analytics
    Security Analytics
    Anomaly Detection Synthetics

  • Search and Query
    Search Query Types
    Query DSL: Fuzzy Query
    Search Templates
    Autocomplete
    Paginate Results
    Scroll
    Sort
    Highlight Matches
    Asynchronous Search
    Cross Cluster Search
    Machine Learning
    KNN
    Aggregations
    Indexing back pressure
    SQL
    Cluster settings
    Learn to Rank

  • Availability and Recovery
    Snapshots
    Cluster Replication
    Get Started
    Auto-follow
    Permissions
    Settings
    Cross-cluster replication API

  • Manage, Monitor, and Tune
    Stack Management
    Performance Analyzer
    From OpenDistro
    Alerting
    Notifications
    Anomaly Detection

  • Machine Learning
    ML Lifecylcle
    ML Commons API
    Supported Algorithms

  • Clients
    Python client
    .NET clients
    Ruby client
    Perl client
    Rust client
    JavaScript client
    Java High-Level REST client
    Java client
    PHP client
    Go client

  • Tools
    OpenSearch CLI
    Data Prepper
    Agents and Ingestion Tools
    Grafana
    Logstash

  • OpenSource API Reference
    REST APIs
    Common REST parameters
    Popular APIs

  • Troubleshooting

  • Developer Guides (links to Javadocs, Dashboards, OpenSearch, Security)

@Naarcha-AWS Naarcha-AWS self-assigned this Sep 28, 2022
@hdhalter hdhalter added the 2 - In progress Issue/PR: The issue or PR is in progress. label Sep 28, 2022
@hdhalter hdhalter added this to the 2022-Q4 milestone Sep 28, 2022
@Naarcha-AWS Naarcha-AWS added 1 - Backlog Issue: The issue is unassigned or assigned but not started Usability and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Sep 28, 2022
@hdhalter
Copy link
Contributor Author

hdhalter commented Sep 30, 2022

  • Target completion = end of Q4
  • We'll backport all changes to v2.0
  • All changes will go to a separate branch for testing
  • TOC changes will be done section by section in order to work with authors so there's no overlap
  • We will add redirects and check for any broken links
  • May introduce a script to manage linking
  • We'll create a schedule for when we will tackle each section

@Naarcha-AWS
Copy link
Collaborator

Added Due Dates to each line item, with an eye to categorizing each based on like sections.

@Naarcha-AWS
Copy link
Collaborator

Naarcha-AWS commented Oct 10, 2022

Here's a linear view of estimated section completion dates:

10/14/2022 ------> 10/24/2022

  • API Reference

10/19/2022 ------> 10/26/2022

  • Clients
  • Tools

10/21/2022 ------> 10/28/2022

  • Index and Ingestion
  • Availability and Recovery

10/26/2002 -----> 11/2/2022

  • Getting Started
  • Installation and Configuration

10/28/2022 -----> 11/9/2022

  • Security

11/2/2022 ----> 11/14/2022

  • Observability

11/4/2022 ----> 11/18/2022

  • Search and Query

11/16/2022 ----> 11/23/2022

  • Dashboards

This was referenced Oct 20, 2022
@Naarcha-AWS
Copy link
Collaborator

Based on the work for the API reference section, I'm adjusting the dates for each section to leave additional room between sections and to allow additional time to complete the task.

New ETA: 11/23/2022

@hdhalter
Copy link
Contributor Author

hdhalter commented Dec 6, 2022

Here is the updated PR for the installation and configuration section: #2130

@hdhalter hdhalter changed the title Restructure the TOC to make it easier for users to find content [Meta] Restructure the TOC to make it easier for users to find content Dec 7, 2022
@Naarcha-AWS
Copy link
Collaborator

Completed by #2946

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress. Usability
Projects
None yet
Development

No branches or pull requests

2 participants