apache/hugegraph-doc

[Imporvement] question with high frequency in user group

Open

#294 opened on Oct 25, 2023

View on GitHub
 (2 comments) (2 reactions) (0 assignees)JavaScript (119 forks)auto 404
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (69 stars)
PR merge metrics
 (PR metrics pending)

Description

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 direction
Review the linked documentation pages and address the todo list items: update quickstart to mention Docker hostname limitation, fix download page 404 errors, improve download page layout, and translate the download page. Ensure consistency in Docker port usage and add summary links for loader.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
DockerGitDocumentation editing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70