opensearch-project/demos

[FEATURE][DocBot] Developer Documentation Cleanup

Aberta

#90 aberto em 6 de nov. de 2023

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável) (18 forks)auto 404
OSCIdocumentationenhancementgood first issue

Métricas do repositório

Stars
 (4 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Revise a documentação de desenvolvimento atual, identifique seções desatualizadas e atualize as para fornecer instruções passo a passo para configurar um ambiente de desenvolvimento, incluindo instruções opcionais para gerar chaves da API Cohere e executar o OpenSearch localmente.
Pilha de tecnologia
None
Domain
documentationdeveloper experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitBasic understanding of developer documentation
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70