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

chore(docs):rename 'graphar' as 'incubator-graphar' in some files #629

Closed
wants to merge 5 commits into from

Conversation

yuhaoran1214
Copy link
Contributor

Reason for this PR

as title

What changes are included in this PR?

rename 'graphar' as 'incubator-graphar' in some files

Are these changes tested?

yes

Are there any user-facing changes?

no

@codecov-commenter
Copy link

codecov-commenter commented Sep 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.28%. Comparing base (c260513) to head (f3c6b91).
Report is 1 commits behind head on main.

Additional details and impacted files
@@              Coverage Diff              @@
##               main     #629       +/-   ##
=============================================
+ Coverage     62.45%   74.28%   +11.82%     
- Complexity        0      226      +226     
=============================================
  Files            60       29       -31     
  Lines          8320     2749     -5571     
  Branches        877      179      -698     
=============================================
- Hits           5196     2042     -3154     
+ Misses         3124      551     -2573     
- Partials          0      156      +156     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@SemyonSinchenko SemyonSinchenko left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@acezen acezen left a comment

Choose a reason for hiding this comment

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

Please double check the changes. Some of them are not necessary.

@@ -22,7 +22,7 @@
{
"name": "GraphAr",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "ghcr.io/apache/graphar-dev:latest",
Copy link
Contributor

Choose a reason for hiding this comment

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

the image name is graphar-dev

LICENSE Outdated
@@ -214,26 +214,26 @@ The text of each license is the standard Apache 2.0 license.

* Apache Spark 3.1.1 and 3.3.4 (https://github.com/apache/spark)
Files:
maven-projects/spark/datasourcs-32/src/main/scala/org/apache/graphar/datasources/GarCommitProtocol.scala
Copy link
Contributor

Choose a reason for hiding this comment

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

The files include in the LICENSE are correct, no need to update them.

@@ -203,8 +203,8 @@ See [GraphAr2Neo4j.scala][graphar2neo4j] for the complete example.

:::

[test-graph-transformer]: https://github.com/apache/incubator-graphar/blob/main/maven-projects/spark/graphar/src/test/scala/org/apache/graphar/TestGraphTransformer.scala
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto, no need to update the links of examples.

licenserc.toml Outdated
@@ -45,19 +45,19 @@ excludes = [
"cpp/apidoc",
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto

@@ -73,7 +73,7 @@ The API document is generated in the directory ``spark/graphar/target/site/scala
## Running Neo4j to GraphAr example

Spark provides a simple example to convert Neo4j data to GraphAr data.
The example is located in the directory ``spark/graphar/src/main/scala/org/apache/graphar/example/``.
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto.

@@ -164,7 +164,7 @@ We can write a json configuration file like `import/neo4j.json` to do the import
Running this example requires `Docker` to be installed, if not, follow [this link](https://docs.docker.com/engine/install/). Run `docker version` to check it.

Spark provides a simple example to convert NebulaGraph data to GraphAr data.
The example is located in the directory ``spark/graphar/src/main/scala/org/apache/graphar/example/``.
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK,I will fix it

maven-projects/spark/README.md Outdated Show resolved Hide resolved
@acezen acezen changed the title feat(format):rename 'graphar' as 'incubator-graphar' in some files chore(docs):rename 'graphar' as 'incubator-graphar' in some files Sep 19, 2024
@acezen
Copy link
Contributor

acezen commented Sep 19, 2024

actually, I think we do not need to rename the graphar to incubator-graphar, since the https://github.com/apache/graphar would redirect to https://github.com/apache/incubator-graphar, we just need to rename that links that can not been redirected.

@yuhaoran1214
Copy link
Contributor Author

actually, I think we do not need to rename the graphar to incubator-graphar, since the https://github.com/apache/graphar would redirect to https://github.com/apache/incubator-graphar, we just need to rename that links that can not been redirected.

Oh, I see what you mean, I'm going to recheck and I will rename the links that can not been redirected.

yuhaoran1214 and others added 3 commits September 21, 2024 11:47
Signed-off-by: Haoran Yu <[email protected]>
Signed-off-by: Haoran Yu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants