opensearch-project/demos

[FEATURE][DocBot] Developer Documentation Cleanup

Aperta

#90 aperta il 6 nov 2023

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari) (18 fork)auto 404
OSCIdocumentationenhancementgood first issue

Metriche repository

Star
 (4 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Rivedere la documentazione dello sviluppo attuale, identificare le sezioni obsolete e aggiornarle per fornire istruzioni passo passo per configurare un ambiente di sviluppo, inclusi passaggi opzionali per generare chiavi API Cohere ed eseguire OpenSearch localmente.
Tech stack
Nessuno
Dominio
documentationdeveloper experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitBasic understanding of developer documentation
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70