opensearch-project/demos

[FEATURE][DocBot] Developer Documentation Cleanup

Ouverte

#90 ouverte le 6 nov. 2023

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée) (18 forks)auto 404
OSCIdocumentationenhancementgood first issue

Métriques du dépôt

Stars
 (4 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Révisez la documentation de développement actuelle, identifiez les sections obsolètes et mettez les à jour pour fournir des instructions étape par étape pour configurer un environnement de développement, y compris des instructions facultatives pour générer des clés API Cohere et exécuter OpenSearch localement.
Stack technique
Aucun
Domaine
documentationdeveloper experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitBasic understanding of developer documentation
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70