opensearch-project/demos

[FEATURE][DocBot] Developer Documentation Cleanup

Offen

#90 geöffnet am 06.11.2023

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen) (18 Forks)auto 404
OSCIdocumentationenhancementgood first issue

Repository-Metriken

Stars
 (4 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Überprüfen Sie die aktuelle Entwicklungsdokumentation, identifizieren Sie veraltete Abschnitte und aktualisieren Sie sie, um Schritt für Schritt Anleitungen zum Einrichten einer Entwicklungsumgebung bereitzustellen, einschließlich optionaler Schritte zum Generieren von Cohere API Schlüsseln und zum lokalen Ausführen von OpenSearch.
Tech Stack
Keine
Domain
documentationdeveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitBasic understanding of developer documentation
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70