Updating refereces from parquet-mr -> parquet-java #60

vinooganesh · 2024-05-21T17:40:15Z

@alamb @wgtmac I put a very basic PR together to update some of the references on the website from parquet-mr to parquet-java. I only chose to do some because I think we have a few questions to figure out first:

Are we going to change the published artifact name of parquet-mr to parquet-java or do we just want to keep publishing under mr?
Do we want to actually "rewrite history" and update the past references (contributions, etc..) in the docs to refer to parquet-java instead? I'm not a fan of rewriting history but figured I'd start a conversation just in case people want to.
Should we also do a sweep and update the contribution guidelines / release template? Per this thread https://lists.apache.org/thread/5oohcx3m16kqs8dmtl3vm1cgd8z0q10b.
Should we introduce a new section of the blog called parquet-java (I had been hacking using the blog for releases) to add a note (assuming we change the name of the artifact) that things have changed?

emkornfield · 2024-05-21T20:50:20Z

content/en/docs/Overview/_index.md

@@ -18,14 +18,14 @@ The parquet-format repository hosts the official specification of the Apache Par
 As a repository focused on specification, the parquet-format repository does not contain source code. 


-### parquet-mr
+### parquet-java


maybe note here that this was previously referred to as parquet-mr due to the name of the repository (which has also been moved)?

i agree adding a note like this would be clearer

The parquet-java repository(previously named `parquet-mr`) is part of the Apache Parquet project and specifically focuses on providing Java tools for

alamb · 2024-05-21T21:55:05Z

@alamb @wgtmac I put a very basic PR together to update some of the references on the website from parquet-mr to parquet-java. I only chose to do some because I think we have a few questions to figure out first:

Are we going to change the published artifact name of parquet-mr to parquet-java or do we just want to keep publishing under mr?

I personally suggest not making this change unless there is a compelling usecase. It seems like it doesn't hurt to leave the artifacts as parquet-mr and would only cause downstream pain to update them now for very little gain

Do we want to actually "rewrite history" and update the past references (contributions, etc..) in the docs to refer to parquet-java instead? I'm not a fan of rewriting history but figured I'd start a conversation just in case people want to.

I recommend against doing this, again on the justification of "what benefit would we get from it"?

Should we also do a sweep and update the contribution guidelines to include the new ways to contribute?

I am not sure what this is asking

Should we introduce a new section of the blog called parquet-java (I had been hacking using the blog for releases) to add a note (assuming we change the name of the artifact) that things have changed?

Maybe we could create a blog post announcing some of the recent changes / activity (e.g. discussion son V3 format, clarifications on repos, new website, etc).

alamb

Looks good to me -- thank you @vinooganesh 🙏

alamb · 2024-05-21T21:56:27Z

README.md

@@ -63,7 +63,7 @@ You can now preview the site locally on http://localhost:1313/

 To create documentation for a new release of `parquet-format` create a new <releaseNumber>.md file under `content/en/blog/parquet-format`. Please see existing files in that directory as an example.

-To create documentation for a new release of `parquet-mr` create a new <releaseNumber>.md file under `content/en/blog/parquet-mr`. Please see existing files in that directory as an example.
+To create documentation for a new release of `parquet-java` create a new <releaseNumber>.md file under `content/en/blog/parquet-java`. Please see existing files in that directory as an example.


I would personally suggest removing the discussion bout release of parquet-mr/ parquet-java to that repo. It seems confusing to have instructions on how to do a release from another repo in parquet-site

Ah I see the confusion - these notes have to do with updating the website announce the new release: https://parquet.apache.org/blog/. So the flow would be

Make a release of parquet-java in that repo

Put up a blog post entry on the website containing the release information

Happy to remove this if folks feel strongly - but was thinking it may be good to have some instructions on how to actually make the post.

I don't feel strongly

alamb · 2024-05-21T21:57:23Z

content/en/_index.html

@@ -24,8 +24,8 @@
 {{% /blocks/feature %}}


-{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/apache/parquet-mr" %}}
-We do a [Pull Request](https://github.com/apache/parquet-mr/pulls) contributions workflow on **GitHub**. New users are always welcome!
+{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/apache/parquet-java" %}}


As part of another PR perhaps we should revisit this link (perhaps it should link to parquet-format?) as again linking to the java implementation from the homepage might be more confusing than helpful

That's a great point. This was actually that was torn about the most when I first built the new site. I figured more people would want to contribute to mr than format (there's actual code in the former), so I went with mr everywhere. More than happy to revisit this as it was mostly just a guess on my part.

I think it is something to revisit as a follow on PR

alamb · 2024-05-21T21:58:00Z

content/en/docs/Overview/_index.md

@@ -18,14 +18,14 @@ The parquet-format repository hosts the official specification of the Apache Par
 As a repository focused on specification, the parquet-format repository does not contain source code. 


-### parquet-mr
+### parquet-java


i agree adding a note like this would be clearer

The parquet-java repository(previously named `parquet-mr`) is part of the Apache Parquet project and specifically focuses on providing Java tools for

vinooganesh · 2024-05-21T22:31:45Z

Thanks @alamb!

Should we also do a sweep and update the contribution guidelines to include the new ways to contribute?
I am not sure what this is asking

Sorry -- this is a typo on my side. I meant to include a new contribution template (edited the message above). It was a response to this thread: https://lists.apache.org/thread/5oohcx3m16kqs8dmtl3vm1cgd8z0q10b.

It's probably worth having separate release announcement templates for parquet-format and parquet-java.

alamb

Thanks again @vinooganesh

emkornfield · 2024-05-22T20:57:35Z

LGTM, thank you @vinooganesh

Updating referencs from parquet-mr -> parquet-java

8fcd619

emkornfield reviewed May 21, 2024

View reviewed changes

alamb reviewed May 21, 2024

View reviewed changes

add note about parquet-java rename

c5531a2

alamb approved these changes May 22, 2024

View reviewed changes

emkornfield merged commit da1d9a8 into apache:production May 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating refereces from parquet-mr -> parquet-java #60

Updating refereces from parquet-mr -> parquet-java #60

vinooganesh commented May 21, 2024 •

edited

Loading

emkornfield May 21, 2024

alamb May 21, 2024

alamb commented May 21, 2024

alamb left a comment

alamb May 21, 2024

vinooganesh May 21, 2024 •

edited

Loading

alamb May 22, 2024

alamb May 21, 2024

vinooganesh May 21, 2024

alamb May 22, 2024

alamb May 21, 2024

vinooganesh commented May 21, 2024

alamb left a comment

emkornfield commented May 22, 2024

Updating refereces from parquet-mr -> parquet-java #60

Updating refereces from parquet-mr -> parquet-java #60

Conversation

vinooganesh commented May 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alamb commented May 21, 2024

alamb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vinooganesh May 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vinooganesh commented May 21, 2024

alamb left a comment

Choose a reason for hiding this comment

emkornfield commented May 22, 2024

vinooganesh commented May 21, 2024 •

edited

Loading

vinooganesh May 21, 2024 •

edited

Loading