opensearch-project/demos

[FEATURE][DocBot] Developer Documentation Cleanup

Open

#90 opened on Nov 6, 2023

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees) (18 forks)auto 404
OSCIdocumentationenhancementgood first issue

Repository metrics

Stars
 (4 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem?

At the moment our development documentation has gotten very out of date.

What solution would you like?

Someone should be able to follow the development documentation and end up with a clean dev environment to get working in the repo. This should include some optional steps for generating Cohere keys along with getting an instance of OpenSearch up and running.

Contributor guide

Research direction
Review current development documentation, identify outdated sections, and update them to provide step by step instructions for setting up a development environment including optional instructions for generating Cohere API keys and running OpenSearch locally.
Tech stack
None
Domain
documentationdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitBasic understanding of developer documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70