iceberg icon indicating copy to clipboard operation
iceberg copied to clipboard

Add More Documentation

Open omervk opened this issue 6 years ago • 4 comments

It would be great to add a bunch of documentation:

  • Design of each part of the system (from TableOperations to Expressions, etc.)
  • Tradeoffs taken in the design of the table format
  • Context bounds - what is and isn't in scope for Iceberg
  • What you need to do to replace Hive with your own metastore
  • Bootstrapping your own use of Iceberg
  • Reasoning for limiting what's possible with Avro schemas

omervk avatar Nov 14 '18 19:11 omervk

@rdblue I think this may be the most pressing issue for the project, especially since it's now an Apache project (incubating). I'll be happy to take up some of it if you like.

omervk avatar Nov 19 '18 14:11 omervk

@omervk, it would be great to have docs contributions! We just created a mkdocs site for the Iceberg incubator project, so you can add docs through pull requests to site on the Iceberg incubator project.

rdblue avatar Nov 19 '18 23:11 rdblue

Great! How will you be working with the other repo? Archiving the current one? Will you be migrating the issues, too?

omervk avatar Nov 20 '18 09:11 omervk

Yes, I'll migrate the issues and then turn off issue tracking here.

rdblue avatar Nov 20 '18 16:11 rdblue