Skip to content

refactor: unify URL prefix in 1.8.0 (draft)#449

Draft
bitflicker64 wants to merge 2 commits intoapache:masterfrom
bitflicker64:fix-url-examples
Draft

refactor: unify URL prefix in 1.8.0 (draft)#449
bitflicker64 wants to merge 2 commits intoapache:masterfrom
bitflicker64:fix-url-examples

Conversation

@bitflicker64
Copy link
Contributor

Purpose of the PR

This PR updates the documentation to reflect the new URL normalization feature introduced in apache/incubator-hugegraph#2944.

Since the server now automatically adds the http:// scheme when missing from URL configurations, this PR removes the http:// prefix from configuration file examples to demonstrate the simplified configuration format.

Main Changes

Updated URL configuration examples in both Chinese (CN) and English (EN) documentation:

Configuration Files Updated:

  • content/cn/docs/config/config-guide.md
  • content/en/docs/config/config-guide.md
  • content/cn/docs/config/config-option.md
  • content/en/docs/config/config-option.md
  • content/cn/docs/quickstart/hugegraph/hugegraph-server.md
  • content/en/docs/quickstart/hugegraph/hugegraph-server.md

Examples Changed:

Before:

restserver.url=http://127.0.0.1:8080
gremlinserver.url=http://127.0.0.1:8182

After:

restserver.url=127.0.0.1:8080
gremlinserver.url=127.0.0.1:8182

What was NOT changed (intentionally):

  • ❌ RESTful API endpoint URLs (e.g., GET http://127.0.0.1:8080/graphs)
  • ❌ curl command examples (require full URL)
  • ❌ Java client code (requires full URL with scheme)
  • ❌ CLI tool --url parameters (require full URL)
  • ❌ HTTPS configuration examples in config-https.md (demonstrates HTTPS feature)

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. enhancement New feature or request labels Feb 2, 2026
@imbajin imbajin changed the title Fix URL Examples refactor: unify URL configs in 1.8.0 (draft) Feb 3, 2026
@imbajin
Copy link
Member

imbajin commented Feb 3, 2026

Thanks for the PR, but due to our website doesn't support multi versions, to avoid confusion(BREAKING CHANGE), we will only merge it in the next release (1.8.0)

And mark it as a draft for now

@imbajin imbajin marked this pull request as draft February 3, 2026 07:17
@imbajin imbajin added this to the 1.8.0 milestone Feb 3, 2026
@imbajin imbajin changed the title refactor: unify URL configs in 1.8.0 (draft) refactor: unify URL prefix in 1.8.0 (draft) Feb 3, 2026
@bitflicker64
Copy link
Contributor Author

Thanks for the PR, but due to our website doesn't support multi versions, to avoid confusion(BREAKING CHANGE), we will only merge it in the next release (1.8.0)

And mark it as a draft for now

makes sense , thanks !!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants