You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@iceberg.apache.org by GitBox <gi...@apache.org> on 2021/12/04 22:59:10 UTC

[GitHub] [iceberg-docs] samredai opened a new pull request #1: First version of hugo doc site

samredai opened a new pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1


   This is the hugo docs-site shared on the dev mailing list and in [apache/iceberg/issues/3616](https://github.com/apache/iceberg/issues/3616). It includes a github workflow that builds and pushes the site to the `asf-site` branch in a subdirectory named after the version. These sites are accessed via the "Releases" navigation menu section and currently I've added `0.12.0`, `0.12.1`, and `next` (we just have to push to branches with the same name). We also need to push to a `latest` branch which the root site automatically redirects to (also driven by the github workflow and a meta tag in the `redirect/index.html` file).
   
   A follow-up item is including some kind of scheduled automated push (daily? weekly?) from the main iceberg repo to the main branch in this repo. This will keep a `/main/docs` version of the site that always up to date with the apache/iceberg/master branch. Thinking about this now, we could probably get rid of the main branch here and set `next` as the default branch for the repo, or alternatively we can have some "if main then next" logic in a couple of places.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-986319585


   Ah, my bad that's from two things:
   
   - Didn't realize I included all of the javadocs, (which accounts for 3,310 files)
   - I included the theme repo in this actual repo but it can be added as a submodule as described [here](https://github.com/alex-shpak/hugo-book#install-as-git-submodule) (which accounts for 177 files)
   
   Converting this to a draft for now while I fix that.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] rdblue commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
rdblue commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-986321968


   Makes sense! Let's remove whatever we can and then follow up with Javadocs in a separate commit for each version once we have the basics. That should let us review it much more easily. Thanks, @samredai.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] jackye1995 commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
jackye1995 commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-989324679


   yes, `next` is really good-to-have stuff, I saw it in a few other Apache websites that's why I brought it up, but if it's too much effort for community to maintain then we can opt-out. Let's definitely focus on getting the historical stable versions out first.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] rdblue commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
rdblue commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r763196285



##########
File path: content/about/about.md
##########
@@ -0,0 +1,9 @@
+---
+Title: What is Iceberg?
+Draft: false
+---
+
+Iceberg adds tables to compute engines including Spark, Trino, PrestoDB, Flink and Hive using a high-performance table format that works just like a SQL table.
+and avoids unpleasant surprises.

Review comment:
       Typo? Looks like a sentence fragment left over from an edit.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] rdblue commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
rdblue commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-989311369


   For the conversation about a `next` branch:
   * I don't see much value in having docs for the upcoming release. Maybe it's just me, but I'd not prioritize this very highly.
   * I'd focus on getting just 0.12.1 done. We can add more versions later
   * Using `main` for the main site makes sense to me because there's a lot of content that isn't specific to a version, like the splash page, spec page, community page, etc. I think those should live in one consistent place, which is probably under `main`.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-986415495


   Updated to not include the javadocs and also to include the theme as a submodule. An overview of the important directories/files.
   
   - `content/docs` directory includes all of the markdown pages
   - `config.toml` includes the hugo site configuration
   - `.github/workflows/deploy.yml` includes the github workflow for deploying versioned sites to the `asf-site` branch
   - `asciinema` directory includes a README and a helper python script to easily generate asciinema recordings


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] rdblue commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
rdblue commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r763192839



##########
File path: README.md
##########
@@ -1,3 +1,19 @@
-## Iceberg Docs
+# Apache Iceberg Documentation Site
 
-This repository contains the markdown documentation hosted at https://iceberg.apache.org.
+This repository contains the documentation for [Apache Iceberg](https://github.com/apache/iceberg).
+It's built with [Hugo](https://gohugo.io/) and hosted on GitHub pages.

Review comment:
       Yeah, I think that it is actually hosted by ASF infra.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] rdblue commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
rdblue commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r763195862



##########
File path: config.toml
##########
@@ -0,0 +1,24 @@
+baseURL = ""  # This is populated by the github deploy workflow and is equal to "<domainName>/<version|latest>"
+languageCode = "en-us"
+title = "Apache Iceberg"
+theme= "hugo-book"
+
+[params]
+  BookLogo = "img/iceberg-logo-icon.png"
+  description = "The open table format for analytic datasets."
+  versions.iceberg = "" # This is populated by the github deploy workflow and is equal to the branch name
+  versions.nessie = "0.15.1"
+  latestVersions.iceberg = "0.12.1"  # This is used for the version badge on the "latest" site version
+
+[[params.social]]
+	title = "devlist"
+	icon = "envelope-o"
+	url = "mailto:dev-subscribe@iceberg.apache.org"

Review comment:
       Rather than linking to the dev list, what about linking to the community page that has a lot more information on the various ways to get involved?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-989259177


   > How are we going to move forward with this PR? If we move to the `next` branch, is this PR for the `main` branch still needed?
   
   If a `next` branch is created I can re-open this PR against that. Or alternatively we could merge this, open a PR `main -> next`, merge that, set `next` as the default branch and then delete `main`. We would also have to remove the `main` directory from the `asf-site` branch, I can follow up with a PR for that.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] rdblue commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
rdblue commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r765314353



##########
File path: config.toml
##########
@@ -0,0 +1,24 @@
+baseURL = ""  # This is populated by the github deploy workflow and is equal to "<domainName>/<version|latest>"
+languageCode = "en-us"
+title = "Apache Iceberg"
+theme= "hugo-book"
+
+[params]
+  BookLogo = "img/iceberg-logo-icon.png"
+  description = "The open table format for analytic datasets."
+  versions.iceberg = "" # This is populated by the github deploy workflow and is equal to the branch name
+  versions.nessie = "0.15.1"
+  latestVersions.iceberg = "0.12.1"  # This is used for the version badge on the "latest" site version
+
+[[params.social]]
+	title = "devlist"
+	icon = "envelope-o"
+	url = "mailto:dev-subscribe@iceberg.apache.org"

Review comment:
       Why not just a "Community" link?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r763658510



##########
File path: config.toml
##########
@@ -0,0 +1,24 @@
+baseURL = ""  # This is populated by the github deploy workflow and is equal to "<domainName>/<version|latest>"
+languageCode = "en-us"
+title = "Apache Iceberg"
+theme= "hugo-book"
+
+[params]
+  BookLogo = "img/iceberg-logo-icon.png"
+  description = "The open table format for analytic datasets."
+  versions.iceberg = "" # This is populated by the github deploy workflow and is equal to the branch name
+  versions.nessie = "0.15.1"
+  latestVersions.iceberg = "0.12.1"  # This is used for the version badge on the "latest" site version
+
+[[params.social]]
+	title = "devlist"
+	icon = "envelope-o"
+	url = "mailto:dev-subscribe@iceberg.apache.org"

Review comment:
       Good idea, updated it to link to the Mailing List portion of the community page and updated the title to "Mailing Lists"




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r763652648



##########
File path: .github/workflows/deploy.yml
##########
@@ -0,0 +1,52 @@
+name: github pages
+
+on: [push, pull_request]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      
+      - name: Set output
+        id: vars
+        run: echo ::set-output name=branch_name::${GITHUB_REF#refs/*/}
+
+      - name: Set baseURL in config.toml
+        uses: ciiiii/toml-editor@1.0.0
+        with:
+          file: "config.toml"
+          key: "baseURL"
+          value: "https://samredai.github.io/iceberg-docs-prototype/${{ steps.vars.outputs.branch_name }}"

Review comment:
       Fixed!




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] jackye1995 commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
jackye1995 commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-986153886


   There are over 3600 files, what are the important files to look into?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] jackye1995 commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
jackye1995 commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r762692930



##########
File path: .github/workflows/deploy.yml
##########
@@ -0,0 +1,52 @@
+name: github pages
+
+on: [push, pull_request]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      
+      - name: Set output
+        id: vars
+        run: echo ::set-output name=branch_name::${GITHUB_REF#refs/*/}
+
+      - name: Set baseURL in config.toml
+        uses: ciiiii/toml-editor@1.0.0
+        with:
+          file: "config.toml"
+          key: "baseURL"
+          value: "https://samredai.github.io/iceberg-docs-prototype/${{ steps.vars.outputs.branch_name }}"

Review comment:
       needs to be updated?

##########
File path: README.md
##########
@@ -1,3 +1,19 @@
-## Iceberg Docs
+# Apache Iceberg Documentation Site
 
-This repository contains the markdown documentation hosted at https://iceberg.apache.org.
+This repository contains the documentation for [Apache Iceberg](https://github.com/apache/iceberg).
+It's built with [Hugo](https://gohugo.io/) and hosted on GitHub pages.

Review comment:
       hosted at https://iceberg.apache.org ?

##########
File path: config.toml
##########
@@ -0,0 +1,24 @@
+baseURL = ""  # This is populated by the github deploy workflow and is equal to "<domainName>/<version|latest>"
+languageCode = "en-us"
+title = "Apache Iceberg"
+theme= "hugo-book"
+
+[params]
+  BookLogo = "img/iceberg-logo-icon.png"
+  description = "The open table format for analytic datasets."
+  versions.iceberg = "" # This is populated by the github deploy workflow and is equal to the branch name
+  versions.nessie = "0.15.1"
+  latestVersions.iceberg = "0.12.1"  # This is used for the version badge on the "latest" site version
+
+[[params.social]]
+	title = "devlist"

Review comment:
       indentation seems off here?
   

##########
File path: asciinema/schema_evolution.py
##########
@@ -0,0 +1,53 @@
+from generate_asciinema_cast import Cast
+
+sequence = [
+    (
+        "ALTER TABLE taxis ADD COLUMN fare_per_distance_unit float AFTER trip_distance;",
+        "Time taken: 0.671 seconds",
+    ),
+    (
+      "DESCRIBE TABLE nyc.taxis;",
+      """VendorID    string
+tpep_pickup_datetime    string

Review comment:
       indentation seems off here?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] rdblue commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
rdblue commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-989309666


   It looks like this isn't quite ready to merge. Most of the text links on pages are broken and the nav menu is really huge. Nav links go to paths like `/spark-ddl/` but I think we probably want to change those to be `/0.12.1/spark-ddl/` for any version-specific pages and `/docs/` or `/community/` for top-level pages.
   
   Is it possible to get all the links working with that structure? Would we need to use relative links within pages like `/0.12.1/spark-ddl/` to get to pages under the same version without specifying the version in each link?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-986105830


   @rdblue @jackye1995 @kbendick @ajantha-bhat @RussellSpitzer @


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] rdblue commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
rdblue commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-986315139


   Yeah, could you break this into smaller commits that we can look at? Why is this almost 3,700 files?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] kbendick commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
kbendick commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-987616428


   > Thinking about this now, we could probably get rid of the main branch here and set next as the default branch for the repo, or alternatively we can have some "if main then next" logic in a couple of places.
   
   I would be in favor of changing the "main" branch name to `next` or whatever we use for latest snapshot.
   
   Having the logical symmetry between the branch names for the versions and the branch name for `next` seems worth it to me (like actively maintained tags).
   
   If doing so provides context AND potentially reduces the need for defensive coding checks at all, I'm all for it. The easier the docs are to work with, the better they'll be.
   
   We can always revert if we don't care for it, but it's probably better to start earlier than well after the fact.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] jackye1995 commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
jackye1995 commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-988424006


   How are we going to move forward with this PR? If we move to the `next` branch, is this PR for the `main` branch still needed?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] jackye1995 commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
jackye1995 commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-989319785


   > I'd focus on getting just 0.12.1 done. We can add more versions later
   
   Yeah I was just gonna ask about that, I thought we are going to first create those doc branches for stable versions, and then handle the `next` version. So my current understanding is that:
   1. this PR will handle all the pages that are not specific to version to get a basic website out
   2. have 1 PR per historical branch to port version specific documentation, focus on 0.12.1 as the first PR and working backwards
   3. After 0.13 releases, we will create one branch for that
   4. start to setup the `next` version that sync from the Iceberg repo
   
   Is this flow still correct?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] rdblue commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
rdblue commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-989323751


   Yeah, that sounds reasonable to me. I still question whether we even want to have `next`. In any case, there's still a lot of work to do here to make sure we have everything the way we want it.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai closed pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai closed pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r763652888



##########
File path: README.md
##########
@@ -1,3 +1,19 @@
-## Iceberg Docs
+# Apache Iceberg Documentation Site
 
-This repository contains the markdown documentation hosted at https://iceberg.apache.org.
+This repository contains the documentation for [Apache Iceberg](https://github.com/apache/iceberg).
+It's built with [Hugo](https://gohugo.io/) and hosted on GitHub pages.

Review comment:
       Fixed!




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] rdblue commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
rdblue commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r763195072



##########
File path: asciinema/schema_evolution.py
##########
@@ -0,0 +1,53 @@
+from generate_asciinema_cast import Cast
+
+sequence = [
+    (
+        "ALTER TABLE taxis ADD COLUMN fare_per_distance_unit float AFTER trip_distance;",
+        "Time taken: 0.671 seconds",
+    ),
+    (
+      "DESCRIBE TABLE nyc.taxis;",
+      """VendorID    string
+tpep_pickup_datetime    string

Review comment:
       I think this is to avoid indentation in the cast




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r763656608



##########
File path: config.toml
##########
@@ -0,0 +1,24 @@
+baseURL = ""  # This is populated by the github deploy workflow and is equal to "<domainName>/<version|latest>"
+languageCode = "en-us"
+title = "Apache Iceberg"
+theme= "hugo-book"
+
+[params]
+  BookLogo = "img/iceberg-logo-icon.png"
+  description = "The open table format for analytic datasets."
+  versions.iceberg = "" # This is populated by the github deploy workflow and is equal to the branch name
+  versions.nessie = "0.15.1"
+  latestVersions.iceberg = "0.12.1"  # This is used for the version badge on the "latest" site version
+
+[[params.social]]
+	title = "devlist"

Review comment:
       Fixed!




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-987600519


   > It looks like the Apache 2.0 license header is missing for some README and script files, please check and add, thanks!
   > 
   > For Python script, it seems like indentation is off at some places. If we do not set up lint in this PR, please make sure we have a task to set it up later.
   
   Thanks for catching this! I added the Apache 2.0 license headers everywhere. I did a quick auto format of the python scripts with black. I'll follow up this PR with a tox file.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r763658651



##########
File path: content/about/about.md
##########
@@ -0,0 +1,9 @@
+---
+Title: What is Iceberg?
+Draft: false
+---
+
+Iceberg adds tables to compute engines including Spark, Trino, PrestoDB, Flink and Hive using a high-performance table format that works just like a SQL table.
+and avoids unpleasant surprises.

Review comment:
       Fixed!




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai edited a comment on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai edited a comment on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-986105830


   @rdblue @jackye1995 @kbendick @ajantha-bhat @RussellSpitzer


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] rdblue commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
rdblue commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r765318518



##########
File path: content/docs/_index.md
##########
@@ -0,0 +1,54 @@
+---
+title: Introduction
+type: docs
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+![Iceberg](../img/Iceberg-logo.png)
+
+**Apache Iceberg is an open table format for huge analytic datasets.** Iceberg adds tables to compute engines including Spark, Trino, PrestoDB, Flink and Hive using a high-performance table format that works just like a SQL table.
+
+### User experience
+
+Iceberg avoids unpleasant surprises. Schema evolution works and won't inadvertently un-delete data. Users don't need to know about partitioning to get fast queries.
+
+* [Schema evolution](evolution#schema-evolution) supports add, drop, update, or rename, and has [no side-effects](evolution#correctness)

Review comment:
       These links are broken for me. This takes me to /docs/evolution#schema-evolution.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] rdblue commented on a change in pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
rdblue commented on a change in pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#discussion_r765318054



##########
File path: config.toml
##########
@@ -0,0 +1,24 @@
+baseURL = ""  # This is populated by the github deploy workflow and is equal to "<domainName>/<version|latest>"
+languageCode = "en-us"
+title = "Apache Iceberg"
+theme= "hugo-book"
+
+[params]
+  BookLogo = "img/iceberg-logo-icon.png"
+  description = "The open table format for analytic datasets."
+  versions.iceberg = "" # This is populated by the github deploy workflow and is equal to the branch name
+  versions.nessie = "0.15.1"
+  latestVersions.iceberg = "0.12.1"  # This is used for the version badge on the "latest" site version
+
+[[params.social]]
+  title = "Mailing Lists"
+  icon = "envelope-o"
+  url = "https://iceberg.apache.org/#community/#mailing-lists"

Review comment:
       This link isn't correct. The hugo site won't use `#community`, it will use the old paths with no `#`. That's a good thing, since that matches the URLs that we've supported for a few years.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [iceberg-docs] samredai commented on pull request #1: First version of hugo doc site

Posted by GitBox <gi...@apache.org>.
samredai commented on pull request #1:
URL: https://github.com/apache/iceberg-docs/pull/1#issuecomment-992183368


   Closing this and continuing in #2 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org