apache/hugegraph-doc

[Imporvement] question with high frequency in user group

Offen

#294 geöffnet am 25.10.2023

Auf GitHub ansehen
 (2 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)JavaScript (119 Forks)auto 404
enhancementgood first issuehelp wanted

Repository-Metriken

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

Beschreibung

Problem Type (问题类型)

lack info (文档描述缺失)

Your Question (问题描述)

Record some questions in user group as a todo list and fix them. Keep updated.

  • We should mention when user use docker to start hubble, they cannot use 'localhost' as hostname. Fix it in quickstart of hubble 4.1.1.
  • We should give a link or change the order of curl the preload sample graph use docker container
  • keep the port in docker run and docker compose the same
  • add the doc about swagger-ui
  • add the summary link of loader and recommend user to use loader to load data instead of hubble
  • hubble code highlight in doc.
  • some 404 in download page: https://hugegraph.apache.org/cn/docs/download/download/
  • Intro how can the container (server/loader/hubble) join a bridge network to use the container_name as hostname
  • download page, the position of Outdated Versions Mapping error
  • translate the download page

Contributor Guide

Research-Richtung
Überprüfen Sie die verlinkten Dokumentationsseiten und bearbeiten Sie die Punkte der To Do Liste: Aktualisieren Sie den Schnellstart, um die Docker Hostname Einschränkung zu erwähnen, beheben Sie 404 Fehler auf der Download Seite, verbessern Sie das Layout der Download Seite und übersetzen Sie die Download Seite. Stellen Sie Konsistenz bei der Docker Port Nutzung sicher und fügen Sie Zusammenfassungslinks für den Loader hinzu.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
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.
1-2 Tage
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
DockerGitDocumentation editing
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70