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

Add More Documentation #104

Open
omervk opened this issue Nov 14, 2018 · 4 comments
Open

Add More Documentation #104

omervk opened this issue Nov 14, 2018 · 4 comments

Comments

@omervk
Copy link
Contributor

omervk commented Nov 14, 2018

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
Copy link
Contributor Author

omervk commented Nov 19, 2018

@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.

@rdblue
Copy link
Contributor

rdblue commented Nov 19, 2018

@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.

@omervk
Copy link
Contributor Author

omervk commented Nov 20, 2018

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

@rdblue
Copy link
Contributor

rdblue commented Nov 20, 2018

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

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

No branches or pull requests

2 participants