Fokko commented on code in PR #8659:
URL: https://github.com/apache/iceberg/pull/8659#discussion_r1338140111
##########
docs-new/.github/workflows/ci.yml:
##########
@@ -0,0 +1,29 @@
+name: ci
+on:
+ push:
+ branches:
+ - master
+ - main
+permissions:
+ contents: write
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - run: |
+ git fetch --tags
+ git worktree add home/docs/1.3.1 docs-1.3.1
+ git worktree add home/javadoc javadoc
+ - uses: actions/setup-python@v4
+ with:
+ python-version: 3.x
+ - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+ - uses: actions/cache@v3
+ with:
+ key: mkdocs-material-${{ env.cache_id }}
+ path: .cache
+ restore-keys: |
+ mkdocs-material-
Review Comment:
I think some cache id is missing here. I would suggest leaving out the
caching initially.
##########
docs-new/.github/workflows/ci.yml:
##########
@@ -0,0 +1,29 @@
+name: ci
+on:
+ push:
+ branches:
+ - master
Review Comment:
I think this is an issue:
> Adjust the structure to match the layout of the website itself, where
./home/*.md contains the evergreen content and ./home/docs/<version>/*.md
contains the versions of Iceberg.
This would mean that it shows features that haven't been released yet. I
think it is great to build these pages, but we have to clearly state that it is
the dev version. I think Arrow is a nice example:
##########
docs-new/.github/workflows/ci.yml:
##########
@@ -0,0 +1,29 @@
+name: ci
+on:
+ push:
+ branches:
+ - master
+ - main
+permissions:
+ contents: write
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - run: |
+ git fetch --tags
+ git worktree add home/docs/1.3.1 docs-1.3.1
+ git worktree add home/javadoc javadoc
+ - uses: actions/setup-python@v4
+ with:
+ python-version: 3.x
+ - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+ - uses: actions/cache@v3
+ with:
+ key: mkdocs-material-${{ env.cache_id }}
+ path: .cache
+ restore-keys: |
+ mkdocs-material-
+ - run: pip install -r requirements.txt
+ - run: mkdocs gh-deploy --force
Review Comment:
In a follow up PR I think it is nice to add the `strict` flag to avoid
slipping in errors.
```suggestion
- run: mkdocs gh-deploy --force --strict
```
##########
docs-new/.github/workflows/ci.yml:
##########
@@ -0,0 +1,29 @@
+name: ci
+on:
+ push:
+ branches:
+ - master
+ - main
+permissions:
+ contents: write
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - run: |
+ git fetch --tags
+ git worktree add home/docs/1.3.1 docs-1.3.1
+ git worktree add home/javadoc javadoc
+ - uses: actions/setup-python@v4
+ with:
+ python-version: 3.x
+ - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+ - uses: actions/cache@v3
+ with:
+ key: mkdocs-material-${{ env.cache_id }}
+ path: .cache
+ restore-keys: |
+ mkdocs-material-
+ - run: pip install -r requirements.txt
+ - run: mkdocs gh-deploy --force
Review Comment:
This will overwrite the PyIceberg site 🕺
I can prioritize the migration to a separate repo. I think we should get
these in and then we're good to go: https://github.com/apache/iceberg/pull/8622
https://github.com/apache/iceberg/pull/8652
https://github.com/apache/iceberg/pull/8651
##########
docs-new/.github/workflows/ci.yml:
##########
@@ -0,0 +1,29 @@
+name: ci
+on:
+ push:
+ branches:
+ - master
+ - main
+permissions:
+ contents: write
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - run: |
+ git fetch --tags
+ git worktree add home/docs/1.3.1 docs-1.3.1
+ git worktree add home/javadoc javadoc
+ - uses: actions/setup-python@v4
+ with:
+ python-version: 3.x
+ - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+ - uses: actions/cache@v3
+ with:
+ key: mkdocs-material-${{ env.cache_id }}
+ path: .cache
+ restore-keys: |
+ mkdocs-material-
+ - run: pip install -r requirements.txt
+ - run: mkdocs gh-deploy --force
Review Comment:
This will overwrite the PyIceberg site 🕺
I can prioritize the migration to a separate repo. I think we should get
these in and then we're good to go: https://github.com/apache/iceberg/pull/8622
https://github.com/apache/iceberg/pull/8652
https://github.com/apache/iceberg/pull/8651
##########
docs-new/.github/workflows/ci.yml:
##########
@@ -0,0 +1,29 @@
+name: ci
+on:
+ push:
+ branches:
+ - master
+ - main
+permissions:
+ contents: write
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - run: |
+ git fetch --tags
+ git worktree add home/docs/1.3.1 docs-1.3.1
+ git worktree add home/javadoc javadoc
+ - uses: actions/setup-python@v4
+ with:
+ python-version: 3.x
+ - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+ - uses: actions/cache@v3
+ with:
+ key: mkdocs-material-${{ env.cache_id }}
+ path: .cache
+ restore-keys: |
+ mkdocs-material-
+ - run: pip install -r requirements.txt
+ - run: mkdocs gh-deploy --force
Review Comment:
Just a heads-up for PyIceberg I had to jump through some hoops because it
also requires a `CNAME` file:
https://github.com/apache/iceberg/blob/master/.github/workflows/python-ci-docs.yml#L46-L56
Probably we also have to make sure that we deprecate the asf-site branch that
currently hosts the docs.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
