Docs: Add separate contributing page for Iceberg website. #4096

amogh-jahagirdar · 2022-02-11T20:54:55Z

Currently, most of the details for contributing are on https://github.com/apache/iceberg/blob/master/CONTRIBUTING.md.
Since the Iceberg website should be the go-to for this information, and there is
enough unique content for contributing we can have a separate page for this on the site.

jackye1995 · 2022-02-11T21:01:52Z

docs/common/community/contributing.md

+ -->
+# Contributing
+
+In this document, you will find some guidelines on contributing to Apache Iceberg. Please keep in mind that none of


jackye1995 · 2022-02-11T21:02:19Z

docs/common/community/contributing.md

+
+## Building the Project Locally
+
+Iceberg is built using Gradle with Java 1.8 or Java 11.


Java 8 or 11

jackye1995 · 2022-02-11T21:03:21Z

docs/common/community/contributing.md

+      3);
+
+  // BAD: arguments and chained methods mixed
+  SomeObject myNewObject = SomeObject.builder(schema, partitionSpec


missing a , at the end

jackye1995 · 2022-02-11T21:04:57Z

Should we also update CONTRIBUTING.md to point to the website link in this PR, or do you plan to do it after the link actually exists?

jackye1995 · 2022-02-11T21:05:51Z

And we need another section for doc contribution guidance described in https://github.com/apache/iceberg-docs/blob/main/README.md, this can be in the same or a different PR.

amogh-jahagirdar · 2022-02-11T22:02:53Z

Should we also update CONTRIBUTING.md to point to the website link in this PR, or do you plan to do it after the link actually exists?

I was planning on doing that after the link exists.

And we need another section for doc contribution guidance described in https://github.com/apache/iceberg-docs/blob/main/README.md, this can be in the same or a different PR.

Good catch, I will just do that in this PR

jackye1995 · 2022-02-12T00:17:36Z

docs/common/community/contributing.md

+* `iceberg-hive-metastore` is an implementation of Iceberg tables backed by the Hive metastore Thrift client
+* `iceberg-data` is an optional module for working with tables directly from JVM applications
+
+This project Iceberg also has modules for adding Iceberg support to processing engines:


There are some recent changes related in #4078 we might want to follow. But I think we can keep this as is for now and later move all these information to multi-engine support page.

Makes sense to me, I think we can tackle this in a follow on.

jackye1995 · 2022-02-12T00:19:04Z

docs/common/community/contributing.md

+* `iceberg-mr` contains an InputFormat and other classes for integrating with Apache Hive
+* `iceberg-pig` is an implementation of Pig's LoadFunc API for Iceberg
+
+## Website and Documentation Updates


I think we also need some explanations of the website repository in this page, basically the first section in the iceberg-docs README. Otherwise it's a bit confusing when reading the contents below.

Agreed, some context on the separate repos would help.

jackye1995 · 2022-02-12T00:20:51Z

docs/common/community/talks.md

 ---
 url: talks
-weight: 300
+weight: 400


why is contributing before talks? I think blogs (200) and talks should be next to each other.

Contributing should not be before talks, I think I was trying to verify if "weight" does what I thought it did and that change got included in this commit 😃 . Will do blogs, talks, and then contributing in that order. Thoughts?

yeah that order sounds good to me

Currently, most of the details for contributing are on https://github.com/apache/iceberg/blob/master/CONTRIBUTING.md. Since the Iceberg website should be the go-to for this information, and there is enough unique content for contributing we can have a separate page for this on the site.

amogh-jahagirdar · 2022-02-13T19:17:17Z

Made a few changes:

1.) Added some more clarifications to the new contributing page.
2.) Removed the existing contribute from the community section on this page. https://iceberg.apache.org/community/
3.) Put weights for the "common/community" markdown files in the "versioned" section. This is what the other MD files are doing, and if I look at the main docs site https://iceberg.apache.org/docs/latest/ we are currently not respecting the existing weights. Although I am not 100% sure why it's necessary to move the weights definitions to the versioned markdown files, it just seems to lead to respecting the weights and also aligns with what other docs are doing, I decided to do that.

@jackye1995 Let me know your thoughts!

jackye1995

looks good to me! @samredai @rdblue do you have any additional comments?

samredai · 2022-02-14T16:23:35Z

docs/common/community/blogs.md

@@ -1,6 +1,5 @@
 ---
 url: blogs
-weight: 200


Thanks for catching this! These were left over from when these pages were moved from versioned to common and you're right, they're no longer needed here.

samredai

Looks good to me, thanks @amogh-jahagirdar!

jackye1995 · 2022-02-14T16:31:14Z

Thanks for contributing @amogh-jahagirdar , and @samredai thanks for the review!

github-actions bot added the docs label Feb 11, 2022

amogh-jahagirdar force-pushed the docs-separate-contributing-page branch from 29a4c72 to ed868c8 Compare February 11, 2022 20:56

jackye1995 reviewed Feb 11, 2022

View reviewed changes

amogh-jahagirdar force-pushed the docs-separate-contributing-page branch from ed868c8 to eef2d1d Compare February 11, 2022 23:38

amogh-jahagirdar requested a review from jackye1995 February 11, 2022 23:39

jackye1995 reviewed Feb 12, 2022

View reviewed changes

amogh-jahagirdar force-pushed the docs-separate-contributing-page branch from eef2d1d to a086623 Compare February 13, 2022 19:08

amogh-jahagirdar force-pushed the docs-separate-contributing-page branch from a086623 to dca0034 Compare February 13, 2022 19:12

amogh-jahagirdar requested a review from jackye1995 February 13, 2022 19:18

jackye1995 approved these changes Feb 14, 2022

View reviewed changes

samredai reviewed Feb 14, 2022

View reviewed changes

samredai approved these changes Feb 14, 2022

View reviewed changes

jackye1995 merged commit 52d246b into apache:master Feb 14, 2022


		## Building the Project Locally

		Iceberg is built using Gradle with Java 1.8 or Java 11.

Docs: Add separate contributing page for Iceberg website. #4096

Docs: Add separate contributing page for Iceberg website. #4096

Uh oh!

Conversation

amogh-jahagirdar commented Feb 11, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jackye1995 commented Feb 11, 2022

Uh oh!

jackye1995 commented Feb 11, 2022

Uh oh!

amogh-jahagirdar commented Feb 11, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amogh-jahagirdar commented Feb 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jackye1995 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samredai left a comment

Choose a reason for hiding this comment

Uh oh!

jackye1995 commented Feb 14, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

amogh-jahagirdar commented Feb 13, 2022 •

edited

Loading