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.

Sign up for GitHub

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

Jump to bottom

doc(hubble): enhance hubble usage doc/command #333

Merged
merged 5 commits into from
May 29, 2024
Merged

doc(hubble): enhance hubble usage doc/command #333

merged 5 commits into from
May 29, 2024

Conversation

returnToInnocence
Copy link
Contributor

@returnToInnocence returnToInnocence commented Mar 6, 2024 •
edited
Loading

Purpose of the PR

  • Currently, the git download target directory and the cd target file directory are inconsistent, so we are trying to unify them

Main Changes

  • Change "cd incubator-hugegraph-toolchain" in en doc Section 2.3 to "cd hugegraph-toolchain"
  • Change "cd incubator-hugegraph-toolchain" in cn doc Section 2.3 to "cd hugegraph-toolchain"
  • In the source compilation section, remove the node and yarn installation flow (en doc & cn doc)
    • The plugin frontend-maven-plugin has been added to hugegraph-hubble/hubble-be/pom.xml. To compile hubble, we do not need to install Nodejs V16.x and yarn environment in your local environment in advance.

@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. enhancement New feature or request labels Mar 6, 2024
imbajin
imbajin reviewed Mar 6, 2024
View reviewed changes
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.

Keep this PR open until the hubble enhancement done (enhance the doc together)

@imbajin imbajin marked this pull request as draft March 6, 2024 09:14
@imbajin imbajin changed the title doc(hugegraph-hubble): Change "cd incubator-hugegraph-toolchain" in Section 2.3 to ""cd hugegraph-toolchain"" doc(hubble): enhance hubble usage doc/command Mar 6, 2024
@returnToInnocence
Copy link
Contributor Author

Keep this PR open until the hubble enhancement done (enhance the doc together)

get it！

@returnToInnocence returnToInnocence marked this pull request as ready for review March 11, 2024 19:06
@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:XS This PR changes 0-9 lines, ignoring generated files. labels Mar 11, 2024
imbajin
imbajin reviewed Mar 25, 2024
View reviewed changes
content/en/docs/quickstart/hugegraph-hubble.md
@@ -135,7 +116,7 @@ git clone https://github.com/apache/hugegraph-toolchain.git
Compile `hubble`. It depends on the loader and client, so you need to build these dependencies in advance during the compilation process (you can skip this step later).

```shell
cd incubator-hugegraph-toolchain
cd hugegraph-toolchain
sudo pip install -r hugegraph-hubble/hubble-dist/assembly/travis/requirements.txt
mvn install -pl hugegraph-client,hugegraph-loader -am -Dmaven.javadoc.skip=true -DskipTests -ntp
cd hugegraph-hubble
Copy link
Member

Choose a reason for hiding this comment

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

fix the useless & confused cmd

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Roger that. Now I will start to test this change

fix the useless & confused cmd

image

Roger that. Now I will start to test this change🫡

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This optimization has been done as follows:
mvn -e package -Dmaven.javadoc.skip=true -Dmaven.test.skip=true -ntp

It will take advantage of Maven's lifecycle mechanisms and may start directly from the build phase (if the project has already been compiled and the source code has not changed) and skip the build phase.

@returnToInnocence returnToInnocence marked this pull request as draft March 25, 2024 08:48
@github-actions GitHub Actions
Copy link

Due to the lack of activity, the current pr is marked as stale and will be closed after 180 days, any update will remove the stale label

@returnToInnocence
Copy link
Contributor Author

Due to the lack of activity, the current pr is marked as stale and will be closed after 180 days, any update will remove the stale label

Please do not close it. Although I have been delayed by other matters due to personal reasons, I have no time to deal with it, but I still record this issue in my todo list, so please keep this issue for me

@github-actions github-actions bot removed the inactive label Apr 25, 2024
@github-actions GitHub Actions
Copy link

Due to the lack of activity, the current pr is marked as stale and will be closed after 180 days, any update will remove the stale label

@returnToInnocence returnToInnocence marked this pull request as ready for review May 29, 2024 02:29
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label May 29, 2024
@imbajin imbajin merged commit 95648c2 into apache:master May 29, 2024
1 check passed
github-actions bot pushed a commit that referenced this pull request May 29, 2024
@imbajin
doc(hubble): enhance hubble usage doc/command (#333) 95648c2
938f044
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@imbajin imbajin imbajin approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request inactive lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@returnToInnocence @imbajin