Repository navigation
[Imporvement] question with high frequency in user group #294
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
curlthe preload sample graph use docker container - keep the port in
docker runanddocker composethe same - add the doc about swagger-ui
- add the summary link of loader and recommend user to use
loaderto load data instead ofhubble -
hubblecode 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 Mappingerror - translate the download page
Reacted by imbajin and VGalaxies
Activity
doc: imporve the doc in apache#294
dosubot commentedon Feb 1, 2024
🤖
It's great to see that you've identified these improvements for the documentation. Your attention to detail will certainly benefit the user group. If you're able to address any of these items and create a pull request, it would be a valuable contribution to the project. Keep up the good work!
This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.
Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.
If you want to continue the conversation, start your reply with @dosu-bot.
rajanarahul93 commentedon Jan 27, 2025
Request to Assign:
Please assign this issue to me, and I will work on improving the documentation to address high-frequency user group questions.
Approach:
Identify Documentation Gaps: Review each listed issue (e.g., Docker hostname, 404 errors, outdated versions mapping) to understand the context and required fixes.
Docker-Specific Updates: Clarify hostname usage for Hubble in Docker, ensure consistent port configurations, and provide details on how containers can join a bridge network.
Preload and Sample Graphs: Reorganize instructions for preloading sample graphs and include appropriate links for better user navigation.
Swagger-UI and Loader Documentation: Add sections about using Swagger-UI and highlight loader usage over Hubble for data loading.
Fix Errors: Address broken links and translation gaps in the download page.
Submit Pull Request: Update the relevant documentation files and submit a detailed pull request for review.
This effort will enhance usability and resolve common user queries effectively.
@imbajin