Shift site build to use monorepo and gh-pages#8919
Conversation
bitsondatadev
requested review from
Fokko,
RussellSpitzer,
ajantha-bhat,
aokolnychyi,
danielcweeks,
nastra and
rdblue
bitsondatadev
force-pushed
the
asf-deploy
branch
6 times, most recently
from
fff5c34 to
b9a11ac
Compare
bitsondatadev
force-pushed
the
asf-deploy
branch
7 times, most recently
from
496a18b to
656ad3b
Compare
bitsondatadev
force-pushed
the
asf-deploy
branch
3 times, most recently
from
005af4d to
a374bd1
Compare
Fokko
left a comment
Fokko
left a comment
There was a problem hiding this comment.
Left some small comments, but in the greater scheme of things; LGTM
bitsondatadev
force-pushed
the
asf-deploy
branch
4 times, most recently
from
7d459c4 to
4b65d1d
Compare
site/README.md
Outdated
| ### Iceberg docs layout | ||
|
|
||
| In the Iceberg docs, since the top-level site and versioned docs are contained in the same directory, they all live under the `/site` directory of the main Iceberg repository. The `/site/docs` directory is named this way to follow the [MkDocs convention](https://www.mkdocs.org/user-guide/configuration/#docs_dir), while the `/site/docs/docs` directory is an analog to the "Docs" navigation tab. Under this directory, you'll find the `/site/docs/docs/nightly` directory, which contains the state of the documentation in the local revisions. | ||
| The static Iceberg website and versioned documentation live together under the `/site` directory of the main Iceberg repository. The `/site/docs` directory is named that way to follow the [MkDocs convention](https://www.mkdocs.org/user-guide/configuration/#docs_dir), while the nested `/site/docs/docs` directory is an analog to the "Docs" navigation tab. The `/site/docs/nightly` directory contains the current state of the versioned documentation with local revisions. |
There was a problem hiding this comment.
minor nit: "directory is named that way to follow the" => "is named following the"
| #### Offline mode | ||
|
|
||
| Run the build command in the root directory, and optionally add `--clean` to force MkDocs to clear previously generated pages. | ||
| One of the great advantages to the MkDocs material plugin is the [offline feature](https://squidfunk.github.io/mkdocs-material/plugins/offline). You can view the Iceberg docs without the need of a server. To enable OFFLINE builds, add theOFFLINE environment variable to either `build` or `serve` recipes. |
There was a problem hiding this comment.
missing space "theOFFLINE"
| pip -q install -r requirements.txt --upgrade | ||
| } | ||
|
|
||
| assert_not_empty () { |
There was a problem hiding this comment.
not a huge deal but may help to pass through an error message so we know which arg is missing
Echo "Missing an argument: $2 "
RussellSpitzer
left a comment
RussellSpitzer
left a comment
There was a problem hiding this comment.
Saw a few nits in the docs, but worked well locally for me. Worktree code seems to working as expected but i'm not an expert in their usage for something like this.
bitsondatadev
force-pushed
the
asf-deploy
branch
from
b0535ab to
f870a4b
Compare
bitsondatadev
force-pushed
the
asf-deploy
branch
5 times, most recently
from
a0ce345 to
884a181
Compare
bitsondatadev
force-pushed
the
asf-deploy
branch
5 times, most recently
from
8b25f83 to
3dc0161
Compare
bitsondatadev
force-pushed
the
asf-deploy
branch
from
3dc0161 to
e0c0000
Compare
Fokko
left a comment
Fokko
left a comment
There was a problem hiding this comment.
Some small comments. I did a local build and it all works. The UI needs a bit of rework, but we can do that in a separate PR. What I do think is that we need to add 1.4.3 in https://github.com/apache/iceberg/tree/docs before merging this.
| ] } ] | ||
| ``` | ||
|
|
||
| ### Content File (Data and Delete) Serialization |
There was a problem hiding this comment.
Not for this PR, but it would be good at some point to just include the spec from the repository itself.
|
@Fokko I updated after your comments! |
…berg look and feel Co-authored-by: Muna Bedan <munabedan@gmail.com>
|
This looks great, and I don't see any open comments. If there is anything we can follow up on in a separate PR. I'll go ahead and rebase and merge this 🚀 Thanks for the reviews @rdblue, @RussellSpitzer, and a special thanks to @bitsondatadev for taking care of the docs! |
5 participants
Revert back to using the
sitedirectory which contains the monorepo of the site and versioned docs. Adds in the site styling to look like the current Apache Iceberg site. Adds the main build infrastructure.I gleaned info from this PR, this PR, this PR and a bit off of this deploy script.
Here is a link to the gh-pages in my branch: https://bitsondatadev.github.io/iceberg/
I will be doing another PR to handle the following task items. when we get some eyes on the current site and if anyone sees any issues.
Also move back to using the asf infra standards including the asf-site branch.
This PR will be moving
/docs/docs/nightly/up to/docs/nightly/based on some bad state that happened when we pulled the versioned docs into the worktree. So most of the changed files are just those files being moved.