Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update Log4j2 configuration and gremlin-console guide #268

Merged
merged 4 commits into from
Jun 12, 2023

Conversation

VGalaxies
Copy link
Contributor

@VGalaxies VGalaxies commented Jun 10, 2023

When starting HugeGraphServer with the script or with IDEA, the log4j configuration file being read is not the same file, which may cause some confusion for new developers. Therefore, I have added this part of the content to clarify it.

The gremlin-console guide is for PR apache/incubator-hugegraph#2231

EN doc will be synchronized later.

Copy link
Member

@imbajin imbajin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, could also update the title of IDEA config doc, reduce the title to setup server in IDEA

image

content/cn/docs/clients/gremlin-console.md Outdated Show resolved Hide resolved
content/cn/docs/clients/gremlin-console.md Show resolved Hide resolved
content/cn/docs/clients/gremlin-console.md Outdated Show resolved Hide resolved
content/cn/docs/clients/gremlin-console.md Outdated Show resolved Hide resolved
content/cn/docs/quickstart/hugegraph-server.md Outdated Show resolved Hide resolved
@imbajin imbajin requested a review from javeme June 12, 2023 07:53
@imbajin
Copy link
Member

imbajin commented Jun 12, 2023

A small tips:
we could paste the url directly if it belongs to the GitHub, and the UI will be more readable

image

@VGalaxies
Copy link
Contributor Author

A small tips: we could paste the url directly if it belongs to the GitHub, and the UI will be more readable

image

Understood, I will take note of it.

…sync the EN docs and reformat hugegraph-server doc
@VGalaxies
Copy link
Contributor Author

Thanks, could also update the title of IDEA config doc, reduce the title to setup server in IDEA

image

Done.

Copy link
Contributor

@javeme javeme left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@imbajin imbajin merged commit 46ee92e into apache:master Jun 12, 2023
1 check passed
github-actions bot pushed a commit that referenced this pull request Jun 12, 2023
* doc: update how to load `example.groovy` when starting server

* doc(gremlin-console, hugegraph-server-idea-setup, hugegraph-server): sync the EN docs and reformat hugegraph-server doc 46ee92e
@imbajin
Copy link
Member

imbajin commented Jun 12, 2023

enhance it next time

image

  • add number ①②... for the problems)
  • better to add a separate line before the reference

@VGalaxies
Copy link
Contributor Author

enhance it next time

image

  • add number ①②... for the problems)
  • better to add a separate line before the reference

Got it.

@imbajin
Copy link
Member

imbajin commented Jun 15, 2023

Also find some outdated configs:

image image - https://hugegraph.apache.org/cn/docs/introduction/readme/

Please refer to [Setup Server in IDEA](/docs/contribution-guidelines/hugegraph-server-idea-setup)

### 9 Create Sample Graph on Server Startup
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need intro the basic arch for server first to let users know how to config it clearly, like the question:

image

maybe enhance it in next PR together

@msgui
Copy link
Contributor

msgui commented Jun 18, 2023

Also find some outdated configs:

image * [hugegraph.apache.org/docs/config/config-guide](https://hugegraph.apache.org/docs/config/config-guide/)

image - https://hugegraph.apache.org/cn/docs/introduction/readme/

Hey @imbajin, I've just updated the outdated configs in pr #272.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants