You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@iceberg.apache.org by Sam Redai <sa...@tabular.io> on 2022/02/01 01:48:06 UTC
New Versioned Iceberg Documentation Site
Hey Everyone,
With 0.13.0's approval for release, I think this would be a good time to
have a discussion around the proposed versioned documentation site, powered
by Hugo. The site is ready to be released and the source code for the site
can be found in the apache/iceberg-docs repository:
https://github.com/apache/iceberg-docs.
In order for everyone to see a dev version of the site live, I've deployed
it temporarily to: https://iceberg.redai.dev
The markdown files will remain in the apache/iceberg repository and will
represent the latest unreleased documentation. PRs for changes to
documentation will be made against the apache/iceberg repository. During a
release, the current version of the docs will be copied from
apache/iceberg, to apache/iceberg-docs, where a new version can then be
deployed by creating a version branch. With the current configuration, a
new version of the documentation site is deployed for each branch name, for
example creating an `0.13.0` branch will deploy an `0.13.0` version of the
site. A particular version can be reached at /docs/<version>. We will also
maintain a `latest` branch which will be a clone of the latest version
branch. All links at the top level (such as from the landing-page) will
link to the `docs/latest` site.
If everyone is ok with this, I'll reach out to the ASF infra team to begin
the process.
Thanks!
-Sam
Re: New Versioned Iceberg Documentation Site
Posted by ru...@gmail.com.
+1, great to see the improvements!
Sent from my iPhone
> On Feb 1, 2022, at 3:21 AM, Ajantha Bhat <aj...@gmail.com> wrote:
>
>
> Nice looking website.
>
> Is the shared link the final version ? I couldn't see the markdown anchor tag inside https://iceberg.redai.dev/spec/
> It will be useful to have that for sharing specific parts of the spec.
>
> Also some pages are in light theme and some are in dark theme. Better to have a unified theme.
>
> +1 for versioning and overall work.
>
> Thanks,
> Ajantha
>
>> On Tue, Feb 1, 2022 at 1:47 PM Eduard Tudenhoefner <ed...@dremio.com> wrote:
>> +1 on the procedure and the new site looks amazing
>>
>>> On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io> wrote:
>>> +1 from me. I think the new site looks great and it is a big improvement to have version-specific docs. Thanks for all your work on this, Sam!
>>>
>>>> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io> wrote:
>>>> Hey Everyone,
>>>>
>>>> With 0.13.0's approval for release, I think this would be a good time to have a discussion around the proposed versioned documentation site, powered by Hugo. The site is ready to be released and the source code for the site can be found in the apache/iceberg-docs repository: https://github.com/apache/iceberg-docs.
>>>>
>>>> In order for everyone to see a dev version of the site live, I've deployed it temporarily to: https://iceberg.redai.dev
>>>>
>>>> The markdown files will remain in the apache/iceberg repository and will represent the latest unreleased documentation. PRs for changes to documentation will be made against the apache/iceberg repository. During a release, the current version of the docs will be copied from apache/iceberg, to apache/iceberg-docs, where a new version can then be deployed by creating a version branch. With the current configuration, a new version of the documentation site is deployed for each branch name, for example creating an `0.13.0` branch will deploy an `0.13.0` version of the site. A particular version can be reached at /docs/<version>. We will also maintain a `latest` branch which will be a clone of the latest version branch. All links at the top level (such as from the landing-page) will link to the `docs/latest` site.
>>>>
>>>> If everyone is ok with this, I'll reach out to the ASF infra team to begin the process.
>>>>
>>>> Thanks!
>>>> -Sam
>>>
>>>
>>> --
>>> Ryan Blue
>>> Tabular
Re: New Versioned Iceberg Documentation Site
Posted by Peter Vary <pv...@cloudera.com.INVALID>.
Nice site Sam!
Thanks for the good work!
Shall we include Hive in the main page?
Thanks,
Peter
On Mon, 7 Feb 2022 at 08:58, Eduard Tudenhoefner <ed...@dremio.com> wrote:
> I agree that design docs and such are currently difficult to find. I just
> wanted to point out that some are linked in
> https://github.com/apache/iceberg/projects. The roadmap
> <https://iceberg.apache.org/#roadmap/> section links to those but it's
> unintuitive to find the respective design docs.
>
> On Mon, Feb 7, 2022 at 3:21 AM OpenInx <op...@gmail.com> wrote:
>
>> The new site looks great to me, thanks all for the work !
>>
>> One unrelated thing: I remember we had a discussion to bring a new page
>> in the doc site to collect all the design docs (such as google doc, github
>> issues etc), is there any progress for this thing ? Someone who
>> connected to me has raised the same question to me before but I did not
>> find the page finally, so I brought it up to this mail list..
>>
>> Thanks.
>>
>> On Sun, Feb 6, 2022 at 10:18 AM Sam Redai <sa...@tabular.io> wrote:
>>
>>> Thanks for all of the comments and feedback!
>>>
>>> @asingh yes I think once we release the new site with versioned docs, we
>>> can start to add things like docker images and more examples. I have some
>>> ideas there but PRs will definitely be welcome! Also I agree, a getting
>>> started page with docker examples would be a good landing-page item with a
>>> Learn More button that takes you directly to a page with more details.
>>>
>>> @omar the font on the Navbar is definitely smaller, mainly to fit all of
>>> the items. If we go with a drop down menu instead, we can increase the font
>>> size.
>>>
>>> Jack and I have been putting the finishing touches on the site. I’m
>>> looking forward to its release this coming week!
>>>
>>> -Sam
>>>
>>> On Wed, Feb 2, 2022 at 12:34 PM Ashish Singh <as...@apache.org> wrote:
>>>
>>>> The website is really great. Thanks Sam!
>>>>
>>>> Is there any plan to link docker images for users to download and try
>>>> out the examples listed on the homepage? If yes, should we maybe add it
>>>> explicitly on the homepage (somewhat at bottom after all the use-cases)?
>>>> Doesn't have to be in the first version.
>>>>
>>>
>>>>
>>>> On Tue, Feb 1, 2022 at 1:50 PM Omar Al-Safi <om...@oalsafi.com> wrote:
>>>>
>>>>> Also, wouldn't it make sense to add a section to reach the
>>>>> integration page from the landing page directly (let's see a drop down
>>>>> menu) at the top section?
>>>>>
>>>>> Regards,
>>>>>
>>>>> On Tue, Feb 1, 2022 at 10:46 PM Omar Al-Safi <om...@oalsafi.com> wrote:
>>>>>
>>>>>> Looking good, thanks Sam!
>>>>>>
>>>>>> However, is it me or is the top section a bit smaller in comparison
>>>>>> to the overall page?
>>>>>>
>>>>>> [image: Screenshot 2022-02-01 at 22.40.49.png]
>>>>>>
>>>>>> Regards,
>>>>>> Omar
>>>>>>
>>>>>> On Tue, Feb 1, 2022 at 9:09 PM Kyle Bendickson <ky...@tabular.io>
>>>>>> wrote:
>>>>>>
>>>>>>> +1 from me. This looks great. Thank you for all your hard work, Sam!
>>>>>>>
>>>>>>> On Tue, Feb 1, 2022 at 10:33 AM Jack Ye <ye...@gmail.com> wrote:
>>>>>>>
>>>>>>>> +1, amazing website! And now the website repo is separated we can
>>>>>>>> continue to iterate and deploy quickly without affecting the main repo, so
>>>>>>>> no need to be 100% perfect as of now.
>>>>>>>>
>>>>>>>> I will update the 0.13 release note against the new website and we
>>>>>>>> can announce them together.
>>>>>>>>
>>>>>>>> Best,
>>>>>>>> Jack Ye
>>>>>>>>
>>>>>>>> On Tue, Feb 1, 2022 at 8:26 AM Ryan Blue <bl...@tabular.io> wrote:
>>>>>>>>
>>>>>>>>> Good catch. Looks like the anchor links on the spec page are
>>>>>>>>> broken. We'll have to get those fixed.
>>>>>>>>>
>>>>>>>>> I think we should move forward with the update and fix these as we
>>>>>>>>> come across them. It's inevitable that we'll have some broken things in a
>>>>>>>>> big change, but we don't want to block this improvement on being 100%
>>>>>>>>> perfect.
>>>>>>>>>
>>>>>>>>> On Tue, Feb 1, 2022 at 1:21 AM Ajantha Bhat <aj...@gmail.com>
>>>>>>>>> wrote:
>>>>>>>>>
>>>>>>>>>> Nice looking website.
>>>>>>>>>>
>>>>>>>>>> Is the shared link the final version ? I couldn't see the
>>>>>>>>>> markdown anchor tag inside https://iceberg.redai.dev/spec/
>>>>>>>>>> It will be useful to have that for sharing specific parts of the
>>>>>>>>>> spec.
>>>>>>>>>>
>>>>>>>>>> Also some pages are in light theme and some are in dark theme.
>>>>>>>>>> Better to have a unified theme.
>>>>>>>>>>
>>>>>>>>>> +1 for versioning and overall work.
>>>>>>>>>>
>>>>>>>>>> Thanks,
>>>>>>>>>> Ajantha
>>>>>>>>>>
>>>>>>>>>> On Tue, Feb 1, 2022 at 1:47 PM Eduard Tudenhoefner <
>>>>>>>>>> eduard@dremio.com> wrote:
>>>>>>>>>>
>>>>>>>>>>> +1 on the procedure and the new site looks amazing
>>>>>>>>>>>
>>>>>>>>>>> On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io>
>>>>>>>>>>> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> +1 from me. I think the new site looks great and it is a big
>>>>>>>>>>>> improvement to have version-specific docs. Thanks for all your work on
>>>>>>>>>>>> this, Sam!
>>>>>>>>>>>>
>>>>>>>>>>>> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io>
>>>>>>>>>>>> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> Hey Everyone,
>>>>>>>>>>>>>
>>>>>>>>>>>>> With 0.13.0's approval for release, I think this would be a
>>>>>>>>>>>>> good time to have a discussion around the proposed versioned documentation
>>>>>>>>>>>>> site, powered by Hugo. The site is ready to be released and the source code
>>>>>>>>>>>>> for the site can be found in the apache/iceberg-docs repository:
>>>>>>>>>>>>> https://github.com/apache/iceberg-docs.
>>>>>>>>>>>>>
>>>>>>>>>>>>> In order for everyone to see a dev version of the site live,
>>>>>>>>>>>>> I've deployed it temporarily to: https://iceberg.redai.dev
>>>>>>>>>>>>>
>>>>>>>>>>>>> The markdown files will remain in the apache/iceberg
>>>>>>>>>>>>> repository and will represent the latest unreleased documentation. PRs for
>>>>>>>>>>>>> changes to documentation will be made against the apache/iceberg
>>>>>>>>>>>>> repository. During a release, the current version of the docs will be
>>>>>>>>>>>>> copied from apache/iceberg, to apache/iceberg-docs, where a new version can
>>>>>>>>>>>>> then be deployed by creating a version branch. With the current
>>>>>>>>>>>>> configuration, a new version of the documentation site is deployed for each
>>>>>>>>>>>>> branch name, for example creating an `0.13.0` branch will deploy an
>>>>>>>>>>>>> `0.13.0` version of the site. A particular version can be reached at
>>>>>>>>>>>>> /docs/<version>. We will also maintain a `latest` branch which will be a
>>>>>>>>>>>>> clone of the latest version branch. All links at the top level (such as
>>>>>>>>>>>>> from the landing-page) will link to the `docs/latest` site.
>>>>>>>>>>>>>
>>>>>>>>>>>>> If everyone is ok with this, I'll reach out to the ASF infra
>>>>>>>>>>>>> team to begin the process.
>>>>>>>>>>>>>
>>>>>>>>>>>>> Thanks!
>>>>>>>>>>>>> -Sam
>>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> --
>>>>>>>>>>>> Ryan Blue
>>>>>>>>>>>> Tabular
>>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>
>>>>>>>>> --
>>>>>>>>> Ryan Blue
>>>>>>>>> Tabular
>>>>>>>>>
>>>>>>>>
Re: New Versioned Iceberg Documentation Site
Posted by Eduard Tudenhoefner <ed...@dremio.com>.
I agree that design docs and such are currently difficult to find. I just
wanted to point out that some are linked in
https://github.com/apache/iceberg/projects. The roadmap
<https://iceberg.apache.org/#roadmap/> section links to those but it's
unintuitive to find the respective design docs.
On Mon, Feb 7, 2022 at 3:21 AM OpenInx <op...@gmail.com> wrote:
> The new site looks great to me, thanks all for the work !
>
> One unrelated thing: I remember we had a discussion to bring a new page
> in the doc site to collect all the design docs (such as google doc, github
> issues etc), is there any progress for this thing ? Someone who
> connected to me has raised the same question to me before but I did not
> find the page finally, so I brought it up to this mail list..
>
> Thanks.
>
> On Sun, Feb 6, 2022 at 10:18 AM Sam Redai <sa...@tabular.io> wrote:
>
>> Thanks for all of the comments and feedback!
>>
>> @asingh yes I think once we release the new site with versioned docs, we
>> can start to add things like docker images and more examples. I have some
>> ideas there but PRs will definitely be welcome! Also I agree, a getting
>> started page with docker examples would be a good landing-page item with a
>> Learn More button that takes you directly to a page with more details.
>>
>> @omar the font on the Navbar is definitely smaller, mainly to fit all of
>> the items. If we go with a drop down menu instead, we can increase the font
>> size.
>>
>> Jack and I have been putting the finishing touches on the site. I’m
>> looking forward to its release this coming week!
>>
>> -Sam
>>
>> On Wed, Feb 2, 2022 at 12:34 PM Ashish Singh <as...@apache.org> wrote:
>>
>>> The website is really great. Thanks Sam!
>>>
>>> Is there any plan to link docker images for users to download and try
>>> out the examples listed on the homepage? If yes, should we maybe add it
>>> explicitly on the homepage (somewhat at bottom after all the use-cases)?
>>> Doesn't have to be in the first version.
>>>
>>
>>>
>>> On Tue, Feb 1, 2022 at 1:50 PM Omar Al-Safi <om...@oalsafi.com> wrote:
>>>
>>>> Also, wouldn't it make sense to add a section to reach the
>>>> integration page from the landing page directly (let's see a drop down
>>>> menu) at the top section?
>>>>
>>>> Regards,
>>>>
>>>> On Tue, Feb 1, 2022 at 10:46 PM Omar Al-Safi <om...@oalsafi.com> wrote:
>>>>
>>>>> Looking good, thanks Sam!
>>>>>
>>>>> However, is it me or is the top section a bit smaller in comparison to
>>>>> the overall page?
>>>>>
>>>>> [image: Screenshot 2022-02-01 at 22.40.49.png]
>>>>>
>>>>> Regards,
>>>>> Omar
>>>>>
>>>>> On Tue, Feb 1, 2022 at 9:09 PM Kyle Bendickson <ky...@tabular.io>
>>>>> wrote:
>>>>>
>>>>>> +1 from me. This looks great. Thank you for all your hard work, Sam!
>>>>>>
>>>>>> On Tue, Feb 1, 2022 at 10:33 AM Jack Ye <ye...@gmail.com> wrote:
>>>>>>
>>>>>>> +1, amazing website! And now the website repo is separated we can
>>>>>>> continue to iterate and deploy quickly without affecting the main repo, so
>>>>>>> no need to be 100% perfect as of now.
>>>>>>>
>>>>>>> I will update the 0.13 release note against the new website and we
>>>>>>> can announce them together.
>>>>>>>
>>>>>>> Best,
>>>>>>> Jack Ye
>>>>>>>
>>>>>>> On Tue, Feb 1, 2022 at 8:26 AM Ryan Blue <bl...@tabular.io> wrote:
>>>>>>>
>>>>>>>> Good catch. Looks like the anchor links on the spec page are
>>>>>>>> broken. We'll have to get those fixed.
>>>>>>>>
>>>>>>>> I think we should move forward with the update and fix these as we
>>>>>>>> come across them. It's inevitable that we'll have some broken things in a
>>>>>>>> big change, but we don't want to block this improvement on being 100%
>>>>>>>> perfect.
>>>>>>>>
>>>>>>>> On Tue, Feb 1, 2022 at 1:21 AM Ajantha Bhat <aj...@gmail.com>
>>>>>>>> wrote:
>>>>>>>>
>>>>>>>>> Nice looking website.
>>>>>>>>>
>>>>>>>>> Is the shared link the final version ? I couldn't see the markdown
>>>>>>>>> anchor tag inside https://iceberg.redai.dev/spec/
>>>>>>>>> It will be useful to have that for sharing specific parts of the
>>>>>>>>> spec.
>>>>>>>>>
>>>>>>>>> Also some pages are in light theme and some are in dark theme.
>>>>>>>>> Better to have a unified theme.
>>>>>>>>>
>>>>>>>>> +1 for versioning and overall work.
>>>>>>>>>
>>>>>>>>> Thanks,
>>>>>>>>> Ajantha
>>>>>>>>>
>>>>>>>>> On Tue, Feb 1, 2022 at 1:47 PM Eduard Tudenhoefner <
>>>>>>>>> eduard@dremio.com> wrote:
>>>>>>>>>
>>>>>>>>>> +1 on the procedure and the new site looks amazing
>>>>>>>>>>
>>>>>>>>>> On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io> wrote:
>>>>>>>>>>
>>>>>>>>>>> +1 from me. I think the new site looks great and it is a big
>>>>>>>>>>> improvement to have version-specific docs. Thanks for all your work on
>>>>>>>>>>> this, Sam!
>>>>>>>>>>>
>>>>>>>>>>> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io>
>>>>>>>>>>> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> Hey Everyone,
>>>>>>>>>>>>
>>>>>>>>>>>> With 0.13.0's approval for release, I think this would be a
>>>>>>>>>>>> good time to have a discussion around the proposed versioned documentation
>>>>>>>>>>>> site, powered by Hugo. The site is ready to be released and the source code
>>>>>>>>>>>> for the site can be found in the apache/iceberg-docs repository:
>>>>>>>>>>>> https://github.com/apache/iceberg-docs.
>>>>>>>>>>>>
>>>>>>>>>>>> In order for everyone to see a dev version of the site live,
>>>>>>>>>>>> I've deployed it temporarily to: https://iceberg.redai.dev
>>>>>>>>>>>>
>>>>>>>>>>>> The markdown files will remain in the apache/iceberg repository
>>>>>>>>>>>> and will represent the latest unreleased documentation. PRs for changes to
>>>>>>>>>>>> documentation will be made against the apache/iceberg repository. During a
>>>>>>>>>>>> release, the current version of the docs will be copied from
>>>>>>>>>>>> apache/iceberg, to apache/iceberg-docs, where a new version can then be
>>>>>>>>>>>> deployed by creating a version branch. With the current configuration, a
>>>>>>>>>>>> new version of the documentation site is deployed for each branch name, for
>>>>>>>>>>>> example creating an `0.13.0` branch will deploy an `0.13.0` version of the
>>>>>>>>>>>> site. A particular version can be reached at /docs/<version>. We will also
>>>>>>>>>>>> maintain a `latest` branch which will be a clone of the latest version
>>>>>>>>>>>> branch. All links at the top level (such as from the landing-page) will
>>>>>>>>>>>> link to the `docs/latest` site.
>>>>>>>>>>>>
>>>>>>>>>>>> If everyone is ok with this, I'll reach out to the ASF infra
>>>>>>>>>>>> team to begin the process.
>>>>>>>>>>>>
>>>>>>>>>>>> Thanks!
>>>>>>>>>>>> -Sam
>>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> --
>>>>>>>>>>> Ryan Blue
>>>>>>>>>>> Tabular
>>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>
>>>>>>>> --
>>>>>>>> Ryan Blue
>>>>>>>> Tabular
>>>>>>>>
>>>>>>>
Re: New Versioned Iceberg Documentation Site
Posted by OpenInx <op...@gmail.com>.
The new site looks great to me, thanks all for the work !
One unrelated thing: I remember we had a discussion to bring a new page in
the doc site to collect all the design docs (such as google doc, github
issues etc), is there any progress for this thing ? Someone who
connected to me has raised the same question to me before but I did not
find the page finally, so I brought it up to this mail list..
Thanks.
On Sun, Feb 6, 2022 at 10:18 AM Sam Redai <sa...@tabular.io> wrote:
> Thanks for all of the comments and feedback!
>
> @asingh yes I think once we release the new site with versioned docs, we
> can start to add things like docker images and more examples. I have some
> ideas there but PRs will definitely be welcome! Also I agree, a getting
> started page with docker examples would be a good landing-page item with a
> Learn More button that takes you directly to a page with more details.
>
> @omar the font on the Navbar is definitely smaller, mainly to fit all of
> the items. If we go with a drop down menu instead, we can increase the font
> size.
>
> Jack and I have been putting the finishing touches on the site. I’m
> looking forward to its release this coming week!
>
> -Sam
>
> On Wed, Feb 2, 2022 at 12:34 PM Ashish Singh <as...@apache.org> wrote:
>
>> The website is really great. Thanks Sam!
>>
>> Is there any plan to link docker images for users to download and try out
>> the examples listed on the homepage? If yes, should we maybe add it
>> explicitly on the homepage (somewhat at bottom after all the use-cases)?
>> Doesn't have to be in the first version.
>>
>
>>
>> On Tue, Feb 1, 2022 at 1:50 PM Omar Al-Safi <om...@oalsafi.com> wrote:
>>
>>> Also, wouldn't it make sense to add a section to reach the
>>> integration page from the landing page directly (let's see a drop down
>>> menu) at the top section?
>>>
>>> Regards,
>>>
>>> On Tue, Feb 1, 2022 at 10:46 PM Omar Al-Safi <om...@oalsafi.com> wrote:
>>>
>>>> Looking good, thanks Sam!
>>>>
>>>> However, is it me or is the top section a bit smaller in comparison to
>>>> the overall page?
>>>>
>>>> [image: Screenshot 2022-02-01 at 22.40.49.png]
>>>>
>>>> Regards,
>>>> Omar
>>>>
>>>> On Tue, Feb 1, 2022 at 9:09 PM Kyle Bendickson <ky...@tabular.io> wrote:
>>>>
>>>>> +1 from me. This looks great. Thank you for all your hard work, Sam!
>>>>>
>>>>> On Tue, Feb 1, 2022 at 10:33 AM Jack Ye <ye...@gmail.com> wrote:
>>>>>
>>>>>> +1, amazing website! And now the website repo is separated we can
>>>>>> continue to iterate and deploy quickly without affecting the main repo, so
>>>>>> no need to be 100% perfect as of now.
>>>>>>
>>>>>> I will update the 0.13 release note against the new website and we
>>>>>> can announce them together.
>>>>>>
>>>>>> Best,
>>>>>> Jack Ye
>>>>>>
>>>>>> On Tue, Feb 1, 2022 at 8:26 AM Ryan Blue <bl...@tabular.io> wrote:
>>>>>>
>>>>>>> Good catch. Looks like the anchor links on the spec page are broken.
>>>>>>> We'll have to get those fixed.
>>>>>>>
>>>>>>> I think we should move forward with the update and fix these as we
>>>>>>> come across them. It's inevitable that we'll have some broken things in a
>>>>>>> big change, but we don't want to block this improvement on being 100%
>>>>>>> perfect.
>>>>>>>
>>>>>>> On Tue, Feb 1, 2022 at 1:21 AM Ajantha Bhat <aj...@gmail.com>
>>>>>>> wrote:
>>>>>>>
>>>>>>>> Nice looking website.
>>>>>>>>
>>>>>>>> Is the shared link the final version ? I couldn't see the markdown
>>>>>>>> anchor tag inside https://iceberg.redai.dev/spec/
>>>>>>>> It will be useful to have that for sharing specific parts of the
>>>>>>>> spec.
>>>>>>>>
>>>>>>>> Also some pages are in light theme and some are in dark theme.
>>>>>>>> Better to have a unified theme.
>>>>>>>>
>>>>>>>> +1 for versioning and overall work.
>>>>>>>>
>>>>>>>> Thanks,
>>>>>>>> Ajantha
>>>>>>>>
>>>>>>>> On Tue, Feb 1, 2022 at 1:47 PM Eduard Tudenhoefner <
>>>>>>>> eduard@dremio.com> wrote:
>>>>>>>>
>>>>>>>>> +1 on the procedure and the new site looks amazing
>>>>>>>>>
>>>>>>>>> On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io> wrote:
>>>>>>>>>
>>>>>>>>>> +1 from me. I think the new site looks great and it is a big
>>>>>>>>>> improvement to have version-specific docs. Thanks for all your work on
>>>>>>>>>> this, Sam!
>>>>>>>>>>
>>>>>>>>>> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io> wrote:
>>>>>>>>>>
>>>>>>>>>>> Hey Everyone,
>>>>>>>>>>>
>>>>>>>>>>> With 0.13.0's approval for release, I think this would be a good
>>>>>>>>>>> time to have a discussion around the proposed versioned documentation site,
>>>>>>>>>>> powered by Hugo. The site is ready to be released and the source code for
>>>>>>>>>>> the site can be found in the apache/iceberg-docs repository:
>>>>>>>>>>> https://github.com/apache/iceberg-docs.
>>>>>>>>>>>
>>>>>>>>>>> In order for everyone to see a dev version of the site live,
>>>>>>>>>>> I've deployed it temporarily to: https://iceberg.redai.dev
>>>>>>>>>>>
>>>>>>>>>>> The markdown files will remain in the apache/iceberg repository
>>>>>>>>>>> and will represent the latest unreleased documentation. PRs for changes to
>>>>>>>>>>> documentation will be made against the apache/iceberg repository. During a
>>>>>>>>>>> release, the current version of the docs will be copied from
>>>>>>>>>>> apache/iceberg, to apache/iceberg-docs, where a new version can then be
>>>>>>>>>>> deployed by creating a version branch. With the current configuration, a
>>>>>>>>>>> new version of the documentation site is deployed for each branch name, for
>>>>>>>>>>> example creating an `0.13.0` branch will deploy an `0.13.0` version of the
>>>>>>>>>>> site. A particular version can be reached at /docs/<version>. We will also
>>>>>>>>>>> maintain a `latest` branch which will be a clone of the latest version
>>>>>>>>>>> branch. All links at the top level (such as from the landing-page) will
>>>>>>>>>>> link to the `docs/latest` site.
>>>>>>>>>>>
>>>>>>>>>>> If everyone is ok with this, I'll reach out to the ASF infra
>>>>>>>>>>> team to begin the process.
>>>>>>>>>>>
>>>>>>>>>>> Thanks!
>>>>>>>>>>> -Sam
>>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> --
>>>>>>>>>> Ryan Blue
>>>>>>>>>> Tabular
>>>>>>>>>>
>>>>>>>>>
>>>>>>>
>>>>>>> --
>>>>>>> Ryan Blue
>>>>>>> Tabular
>>>>>>>
>>>>>>
Re: New Versioned Iceberg Documentation Site
Posted by Sam Redai <sa...@tabular.io>.
Thanks for all of the comments and feedback!
@asingh yes I think once we release the new site with versioned docs, we
can start to add things like docker images and more examples. I have some
ideas there but PRs will definitely be welcome! Also I agree, a getting
started page with docker examples would be a good landing-page item with a
Learn More button that takes you directly to a page with more details.
@omar the font on the Navbar is definitely smaller, mainly to fit all of
the items. If we go with a drop down menu instead, we can increase the font
size.
Jack and I have been putting the finishing touches on the site. I’m looking
forward to its release this coming week!
-Sam
On Wed, Feb 2, 2022 at 12:34 PM Ashish Singh <as...@apache.org> wrote:
> The website is really great. Thanks Sam!
>
> Is there any plan to link docker images for users to download and try out
> the examples listed on the homepage? If yes, should we maybe add it
> explicitly on the homepage (somewhat at bottom after all the use-cases)?
> Doesn't have to be in the first version.
>
>
> On Tue, Feb 1, 2022 at 1:50 PM Omar Al-Safi <om...@oalsafi.com> wrote:
>
>> Also, wouldn't it make sense to add a section to reach the
>> integration page from the landing page directly (let's see a drop down
>> menu) at the top section?
>>
>> Regards,
>>
>> On Tue, Feb 1, 2022 at 10:46 PM Omar Al-Safi <om...@oalsafi.com> wrote:
>>
>>> Looking good, thanks Sam!
>>>
>>> However, is it me or is the top section a bit smaller in comparison to
>>> the overall page?
>>>
>>> [image: Screenshot 2022-02-01 at 22.40.49.png]
>>>
>>> Regards,
>>> Omar
>>>
>>> On Tue, Feb 1, 2022 at 9:09 PM Kyle Bendickson <ky...@tabular.io> wrote:
>>>
>>>> +1 from me. This looks great. Thank you for all your hard work, Sam!
>>>>
>>>> On Tue, Feb 1, 2022 at 10:33 AM Jack Ye <ye...@gmail.com> wrote:
>>>>
>>>>> +1, amazing website! And now the website repo is separated we can
>>>>> continue to iterate and deploy quickly without affecting the main repo, so
>>>>> no need to be 100% perfect as of now.
>>>>>
>>>>> I will update the 0.13 release note against the new website and we can
>>>>> announce them together.
>>>>>
>>>>> Best,
>>>>> Jack Ye
>>>>>
>>>>> On Tue, Feb 1, 2022 at 8:26 AM Ryan Blue <bl...@tabular.io> wrote:
>>>>>
>>>>>> Good catch. Looks like the anchor links on the spec page are broken.
>>>>>> We'll have to get those fixed.
>>>>>>
>>>>>> I think we should move forward with the update and fix these as we
>>>>>> come across them. It's inevitable that we'll have some broken things in a
>>>>>> big change, but we don't want to block this improvement on being 100%
>>>>>> perfect.
>>>>>>
>>>>>> On Tue, Feb 1, 2022 at 1:21 AM Ajantha Bhat <aj...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> Nice looking website.
>>>>>>>
>>>>>>> Is the shared link the final version ? I couldn't see the markdown
>>>>>>> anchor tag inside https://iceberg.redai.dev/spec/
>>>>>>> It will be useful to have that for sharing specific parts of the
>>>>>>> spec.
>>>>>>>
>>>>>>> Also some pages are in light theme and some are in dark theme.
>>>>>>> Better to have a unified theme.
>>>>>>>
>>>>>>> +1 for versioning and overall work.
>>>>>>>
>>>>>>> Thanks,
>>>>>>> Ajantha
>>>>>>>
>>>>>>> On Tue, Feb 1, 2022 at 1:47 PM Eduard Tudenhoefner <
>>>>>>> eduard@dremio.com> wrote:
>>>>>>>
>>>>>>>> +1 on the procedure and the new site looks amazing
>>>>>>>>
>>>>>>>> On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io> wrote:
>>>>>>>>
>>>>>>>>> +1 from me. I think the new site looks great and it is a big
>>>>>>>>> improvement to have version-specific docs. Thanks for all your work on
>>>>>>>>> this, Sam!
>>>>>>>>>
>>>>>>>>> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io> wrote:
>>>>>>>>>
>>>>>>>>>> Hey Everyone,
>>>>>>>>>>
>>>>>>>>>> With 0.13.0's approval for release, I think this would be a good
>>>>>>>>>> time to have a discussion around the proposed versioned documentation site,
>>>>>>>>>> powered by Hugo. The site is ready to be released and the source code for
>>>>>>>>>> the site can be found in the apache/iceberg-docs repository:
>>>>>>>>>> https://github.com/apache/iceberg-docs.
>>>>>>>>>>
>>>>>>>>>> In order for everyone to see a dev version of the site live, I've
>>>>>>>>>> deployed it temporarily to: https://iceberg.redai.dev
>>>>>>>>>>
>>>>>>>>>> The markdown files will remain in the apache/iceberg repository
>>>>>>>>>> and will represent the latest unreleased documentation. PRs for changes to
>>>>>>>>>> documentation will be made against the apache/iceberg repository. During a
>>>>>>>>>> release, the current version of the docs will be copied from
>>>>>>>>>> apache/iceberg, to apache/iceberg-docs, where a new version can then be
>>>>>>>>>> deployed by creating a version branch. With the current configuration, a
>>>>>>>>>> new version of the documentation site is deployed for each branch name, for
>>>>>>>>>> example creating an `0.13.0` branch will deploy an `0.13.0` version of the
>>>>>>>>>> site. A particular version can be reached at /docs/<version>. We will also
>>>>>>>>>> maintain a `latest` branch which will be a clone of the latest version
>>>>>>>>>> branch. All links at the top level (such as from the landing-page) will
>>>>>>>>>> link to the `docs/latest` site.
>>>>>>>>>>
>>>>>>>>>> If everyone is ok with this, I'll reach out to the ASF infra team
>>>>>>>>>> to begin the process.
>>>>>>>>>>
>>>>>>>>>> Thanks!
>>>>>>>>>> -Sam
>>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> --
>>>>>>>>> Ryan Blue
>>>>>>>>> Tabular
>>>>>>>>>
>>>>>>>>
>>>>>>
>>>>>> --
>>>>>> Ryan Blue
>>>>>> Tabular
>>>>>>
>>>>>
Re: New Versioned Iceberg Documentation Site
Posted by Ashish Singh <as...@apache.org>.
The website is really great. Thanks Sam!
Is there any plan to link docker images for users to download and try out
the examples listed on the homepage? If yes, should we maybe add it
explicitly on the homepage (somewhat at bottom after all the use-cases)?
Doesn't have to be in the first version.
On Tue, Feb 1, 2022 at 1:50 PM Omar Al-Safi <om...@oalsafi.com> wrote:
> Also, wouldn't it make sense to add a section to reach the
> integration page from the landing page directly (let's see a drop down
> menu) at the top section?
>
> Regards,
>
> On Tue, Feb 1, 2022 at 10:46 PM Omar Al-Safi <om...@oalsafi.com> wrote:
>
>> Looking good, thanks Sam!
>>
>> However, is it me or is the top section a bit smaller in comparison to
>> the overall page?
>>
>> [image: Screenshot 2022-02-01 at 22.40.49.png]
>>
>> Regards,
>> Omar
>>
>> On Tue, Feb 1, 2022 at 9:09 PM Kyle Bendickson <ky...@tabular.io> wrote:
>>
>>> +1 from me. This looks great. Thank you for all your hard work, Sam!
>>>
>>> On Tue, Feb 1, 2022 at 10:33 AM Jack Ye <ye...@gmail.com> wrote:
>>>
>>>> +1, amazing website! And now the website repo is separated we can
>>>> continue to iterate and deploy quickly without affecting the main repo, so
>>>> no need to be 100% perfect as of now.
>>>>
>>>> I will update the 0.13 release note against the new website and we can
>>>> announce them together.
>>>>
>>>> Best,
>>>> Jack Ye
>>>>
>>>> On Tue, Feb 1, 2022 at 8:26 AM Ryan Blue <bl...@tabular.io> wrote:
>>>>
>>>>> Good catch. Looks like the anchor links on the spec page are broken.
>>>>> We'll have to get those fixed.
>>>>>
>>>>> I think we should move forward with the update and fix these as we
>>>>> come across them. It's inevitable that we'll have some broken things in a
>>>>> big change, but we don't want to block this improvement on being 100%
>>>>> perfect.
>>>>>
>>>>> On Tue, Feb 1, 2022 at 1:21 AM Ajantha Bhat <aj...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> Nice looking website.
>>>>>>
>>>>>> Is the shared link the final version ? I couldn't see the markdown
>>>>>> anchor tag inside https://iceberg.redai.dev/spec/
>>>>>> It will be useful to have that for sharing specific parts of the spec.
>>>>>>
>>>>>> Also some pages are in light theme and some are in dark theme. Better
>>>>>> to have a unified theme.
>>>>>>
>>>>>> +1 for versioning and overall work.
>>>>>>
>>>>>> Thanks,
>>>>>> Ajantha
>>>>>>
>>>>>> On Tue, Feb 1, 2022 at 1:47 PM Eduard Tudenhoefner <ed...@dremio.com>
>>>>>> wrote:
>>>>>>
>>>>>>> +1 on the procedure and the new site looks amazing
>>>>>>>
>>>>>>> On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io> wrote:
>>>>>>>
>>>>>>>> +1 from me. I think the new site looks great and it is a big
>>>>>>>> improvement to have version-specific docs. Thanks for all your work on
>>>>>>>> this, Sam!
>>>>>>>>
>>>>>>>> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io> wrote:
>>>>>>>>
>>>>>>>>> Hey Everyone,
>>>>>>>>>
>>>>>>>>> With 0.13.0's approval for release, I think this would be a good
>>>>>>>>> time to have a discussion around the proposed versioned documentation site,
>>>>>>>>> powered by Hugo. The site is ready to be released and the source code for
>>>>>>>>> the site can be found in the apache/iceberg-docs repository:
>>>>>>>>> https://github.com/apache/iceberg-docs.
>>>>>>>>>
>>>>>>>>> In order for everyone to see a dev version of the site live, I've
>>>>>>>>> deployed it temporarily to: https://iceberg.redai.dev
>>>>>>>>>
>>>>>>>>> The markdown files will remain in the apache/iceberg repository
>>>>>>>>> and will represent the latest unreleased documentation. PRs for changes to
>>>>>>>>> documentation will be made against the apache/iceberg repository. During a
>>>>>>>>> release, the current version of the docs will be copied from
>>>>>>>>> apache/iceberg, to apache/iceberg-docs, where a new version can then be
>>>>>>>>> deployed by creating a version branch. With the current configuration, a
>>>>>>>>> new version of the documentation site is deployed for each branch name, for
>>>>>>>>> example creating an `0.13.0` branch will deploy an `0.13.0` version of the
>>>>>>>>> site. A particular version can be reached at /docs/<version>. We will also
>>>>>>>>> maintain a `latest` branch which will be a clone of the latest version
>>>>>>>>> branch. All links at the top level (such as from the landing-page) will
>>>>>>>>> link to the `docs/latest` site.
>>>>>>>>>
>>>>>>>>> If everyone is ok with this, I'll reach out to the ASF infra team
>>>>>>>>> to begin the process.
>>>>>>>>>
>>>>>>>>> Thanks!
>>>>>>>>> -Sam
>>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> --
>>>>>>>> Ryan Blue
>>>>>>>> Tabular
>>>>>>>>
>>>>>>>
>>>>>
>>>>> --
>>>>> Ryan Blue
>>>>> Tabular
>>>>>
>>>>
Re: New Versioned Iceberg Documentation Site
Posted by Omar Al-Safi <om...@oalsafi.com>.
Also, wouldn't it make sense to add a section to reach the integration page
from the landing page directly (let's see a drop down menu) at the top
section?
Regards,
On Tue, Feb 1, 2022 at 10:46 PM Omar Al-Safi <om...@oalsafi.com> wrote:
> Looking good, thanks Sam!
>
> However, is it me or is the top section a bit smaller in comparison to the
> overall page?
>
> [image: Screenshot 2022-02-01 at 22.40.49.png]
>
> Regards,
> Omar
>
> On Tue, Feb 1, 2022 at 9:09 PM Kyle Bendickson <ky...@tabular.io> wrote:
>
>> +1 from me. This looks great. Thank you for all your hard work, Sam!
>>
>> On Tue, Feb 1, 2022 at 10:33 AM Jack Ye <ye...@gmail.com> wrote:
>>
>>> +1, amazing website! And now the website repo is separated we can
>>> continue to iterate and deploy quickly without affecting the main repo, so
>>> no need to be 100% perfect as of now.
>>>
>>> I will update the 0.13 release note against the new website and we can
>>> announce them together.
>>>
>>> Best,
>>> Jack Ye
>>>
>>> On Tue, Feb 1, 2022 at 8:26 AM Ryan Blue <bl...@tabular.io> wrote:
>>>
>>>> Good catch. Looks like the anchor links on the spec page are broken.
>>>> We'll have to get those fixed.
>>>>
>>>> I think we should move forward with the update and fix these as we come
>>>> across them. It's inevitable that we'll have some broken things in a big
>>>> change, but we don't want to block this improvement on being 100% perfect.
>>>>
>>>> On Tue, Feb 1, 2022 at 1:21 AM Ajantha Bhat <aj...@gmail.com>
>>>> wrote:
>>>>
>>>>> Nice looking website.
>>>>>
>>>>> Is the shared link the final version ? I couldn't see the markdown
>>>>> anchor tag inside https://iceberg.redai.dev/spec/
>>>>> It will be useful to have that for sharing specific parts of the spec.
>>>>>
>>>>> Also some pages are in light theme and some are in dark theme. Better
>>>>> to have a unified theme.
>>>>>
>>>>> +1 for versioning and overall work.
>>>>>
>>>>> Thanks,
>>>>> Ajantha
>>>>>
>>>>> On Tue, Feb 1, 2022 at 1:47 PM Eduard Tudenhoefner <ed...@dremio.com>
>>>>> wrote:
>>>>>
>>>>>> +1 on the procedure and the new site looks amazing
>>>>>>
>>>>>> On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io> wrote:
>>>>>>
>>>>>>> +1 from me. I think the new site looks great and it is a big
>>>>>>> improvement to have version-specific docs. Thanks for all your work on
>>>>>>> this, Sam!
>>>>>>>
>>>>>>> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io> wrote:
>>>>>>>
>>>>>>>> Hey Everyone,
>>>>>>>>
>>>>>>>> With 0.13.0's approval for release, I think this would be a good
>>>>>>>> time to have a discussion around the proposed versioned documentation site,
>>>>>>>> powered by Hugo. The site is ready to be released and the source code for
>>>>>>>> the site can be found in the apache/iceberg-docs repository:
>>>>>>>> https://github.com/apache/iceberg-docs.
>>>>>>>>
>>>>>>>> In order for everyone to see a dev version of the site live, I've
>>>>>>>> deployed it temporarily to: https://iceberg.redai.dev
>>>>>>>>
>>>>>>>> The markdown files will remain in the apache/iceberg repository and
>>>>>>>> will represent the latest unreleased documentation. PRs for changes to
>>>>>>>> documentation will be made against the apache/iceberg repository. During a
>>>>>>>> release, the current version of the docs will be copied from
>>>>>>>> apache/iceberg, to apache/iceberg-docs, where a new version can then be
>>>>>>>> deployed by creating a version branch. With the current configuration, a
>>>>>>>> new version of the documentation site is deployed for each branch name, for
>>>>>>>> example creating an `0.13.0` branch will deploy an `0.13.0` version of the
>>>>>>>> site. A particular version can be reached at /docs/<version>. We will also
>>>>>>>> maintain a `latest` branch which will be a clone of the latest version
>>>>>>>> branch. All links at the top level (such as from the landing-page) will
>>>>>>>> link to the `docs/latest` site.
>>>>>>>>
>>>>>>>> If everyone is ok with this, I'll reach out to the ASF infra team
>>>>>>>> to begin the process.
>>>>>>>>
>>>>>>>> Thanks!
>>>>>>>> -Sam
>>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> --
>>>>>>> Ryan Blue
>>>>>>> Tabular
>>>>>>>
>>>>>>
>>>>
>>>> --
>>>> Ryan Blue
>>>> Tabular
>>>>
>>>
Re: New Versioned Iceberg Documentation Site
Posted by Omar Al-Safi <om...@oalsafi.com>.
Looking good, thanks Sam!
However, is it me or is the top section a bit smaller in comparison to the
overall page?
[image: Screenshot 2022-02-01 at 22.40.49.png]
Regards,
Omar
On Tue, Feb 1, 2022 at 9:09 PM Kyle Bendickson <ky...@tabular.io> wrote:
> +1 from me. This looks great. Thank you for all your hard work, Sam!
>
> On Tue, Feb 1, 2022 at 10:33 AM Jack Ye <ye...@gmail.com> wrote:
>
>> +1, amazing website! And now the website repo is separated we can
>> continue to iterate and deploy quickly without affecting the main repo, so
>> no need to be 100% perfect as of now.
>>
>> I will update the 0.13 release note against the new website and we can
>> announce them together.
>>
>> Best,
>> Jack Ye
>>
>> On Tue, Feb 1, 2022 at 8:26 AM Ryan Blue <bl...@tabular.io> wrote:
>>
>>> Good catch. Looks like the anchor links on the spec page are broken.
>>> We'll have to get those fixed.
>>>
>>> I think we should move forward with the update and fix these as we come
>>> across them. It's inevitable that we'll have some broken things in a big
>>> change, but we don't want to block this improvement on being 100% perfect.
>>>
>>> On Tue, Feb 1, 2022 at 1:21 AM Ajantha Bhat <aj...@gmail.com>
>>> wrote:
>>>
>>>> Nice looking website.
>>>>
>>>> Is the shared link the final version ? I couldn't see the markdown
>>>> anchor tag inside https://iceberg.redai.dev/spec/
>>>> It will be useful to have that for sharing specific parts of the spec.
>>>>
>>>> Also some pages are in light theme and some are in dark theme. Better
>>>> to have a unified theme.
>>>>
>>>> +1 for versioning and overall work.
>>>>
>>>> Thanks,
>>>> Ajantha
>>>>
>>>> On Tue, Feb 1, 2022 at 1:47 PM Eduard Tudenhoefner <ed...@dremio.com>
>>>> wrote:
>>>>
>>>>> +1 on the procedure and the new site looks amazing
>>>>>
>>>>> On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io> wrote:
>>>>>
>>>>>> +1 from me. I think the new site looks great and it is a big
>>>>>> improvement to have version-specific docs. Thanks for all your work on
>>>>>> this, Sam!
>>>>>>
>>>>>> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io> wrote:
>>>>>>
>>>>>>> Hey Everyone,
>>>>>>>
>>>>>>> With 0.13.0's approval for release, I think this would be a good
>>>>>>> time to have a discussion around the proposed versioned documentation site,
>>>>>>> powered by Hugo. The site is ready to be released and the source code for
>>>>>>> the site can be found in the apache/iceberg-docs repository:
>>>>>>> https://github.com/apache/iceberg-docs.
>>>>>>>
>>>>>>> In order for everyone to see a dev version of the site live, I've
>>>>>>> deployed it temporarily to: https://iceberg.redai.dev
>>>>>>>
>>>>>>> The markdown files will remain in the apache/iceberg repository and
>>>>>>> will represent the latest unreleased documentation. PRs for changes to
>>>>>>> documentation will be made against the apache/iceberg repository. During a
>>>>>>> release, the current version of the docs will be copied from
>>>>>>> apache/iceberg, to apache/iceberg-docs, where a new version can then be
>>>>>>> deployed by creating a version branch. With the current configuration, a
>>>>>>> new version of the documentation site is deployed for each branch name, for
>>>>>>> example creating an `0.13.0` branch will deploy an `0.13.0` version of the
>>>>>>> site. A particular version can be reached at /docs/<version>. We will also
>>>>>>> maintain a `latest` branch which will be a clone of the latest version
>>>>>>> branch. All links at the top level (such as from the landing-page) will
>>>>>>> link to the `docs/latest` site.
>>>>>>>
>>>>>>> If everyone is ok with this, I'll reach out to the ASF infra team to
>>>>>>> begin the process.
>>>>>>>
>>>>>>> Thanks!
>>>>>>> -Sam
>>>>>>>
>>>>>>
>>>>>>
>>>>>> --
>>>>>> Ryan Blue
>>>>>> Tabular
>>>>>>
>>>>>
>>>
>>> --
>>> Ryan Blue
>>> Tabular
>>>
>>
Re: New Versioned Iceberg Documentation Site
Posted by Kyle Bendickson <ky...@tabular.io>.
+1 from me. This looks great. Thank you for all your hard work, Sam!
On Tue, Feb 1, 2022 at 10:33 AM Jack Ye <ye...@gmail.com> wrote:
> +1, amazing website! And now the website repo is separated we can continue
> to iterate and deploy quickly without affecting the main repo, so no need
> to be 100% perfect as of now.
>
> I will update the 0.13 release note against the new website and we can
> announce them together.
>
> Best,
> Jack Ye
>
> On Tue, Feb 1, 2022 at 8:26 AM Ryan Blue <bl...@tabular.io> wrote:
>
>> Good catch. Looks like the anchor links on the spec page are broken.
>> We'll have to get those fixed.
>>
>> I think we should move forward with the update and fix these as we come
>> across them. It's inevitable that we'll have some broken things in a big
>> change, but we don't want to block this improvement on being 100% perfect.
>>
>> On Tue, Feb 1, 2022 at 1:21 AM Ajantha Bhat <aj...@gmail.com>
>> wrote:
>>
>>> Nice looking website.
>>>
>>> Is the shared link the final version ? I couldn't see the markdown
>>> anchor tag inside https://iceberg.redai.dev/spec/
>>> It will be useful to have that for sharing specific parts of the spec.
>>>
>>> Also some pages are in light theme and some are in dark theme. Better to
>>> have a unified theme.
>>>
>>> +1 for versioning and overall work.
>>>
>>> Thanks,
>>> Ajantha
>>>
>>> On Tue, Feb 1, 2022 at 1:47 PM Eduard Tudenhoefner <ed...@dremio.com>
>>> wrote:
>>>
>>>> +1 on the procedure and the new site looks amazing
>>>>
>>>> On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io> wrote:
>>>>
>>>>> +1 from me. I think the new site looks great and it is a big
>>>>> improvement to have version-specific docs. Thanks for all your work on
>>>>> this, Sam!
>>>>>
>>>>> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io> wrote:
>>>>>
>>>>>> Hey Everyone,
>>>>>>
>>>>>> With 0.13.0's approval for release, I think this would be a good time
>>>>>> to have a discussion around the proposed versioned documentation site,
>>>>>> powered by Hugo. The site is ready to be released and the source code for
>>>>>> the site can be found in the apache/iceberg-docs repository:
>>>>>> https://github.com/apache/iceberg-docs.
>>>>>>
>>>>>> In order for everyone to see a dev version of the site live, I've
>>>>>> deployed it temporarily to: https://iceberg.redai.dev
>>>>>>
>>>>>> The markdown files will remain in the apache/iceberg repository and
>>>>>> will represent the latest unreleased documentation. PRs for changes to
>>>>>> documentation will be made against the apache/iceberg repository. During a
>>>>>> release, the current version of the docs will be copied from
>>>>>> apache/iceberg, to apache/iceberg-docs, where a new version can then be
>>>>>> deployed by creating a version branch. With the current configuration, a
>>>>>> new version of the documentation site is deployed for each branch name, for
>>>>>> example creating an `0.13.0` branch will deploy an `0.13.0` version of the
>>>>>> site. A particular version can be reached at /docs/<version>. We will also
>>>>>> maintain a `latest` branch which will be a clone of the latest version
>>>>>> branch. All links at the top level (such as from the landing-page) will
>>>>>> link to the `docs/latest` site.
>>>>>>
>>>>>> If everyone is ok with this, I'll reach out to the ASF infra team to
>>>>>> begin the process.
>>>>>>
>>>>>> Thanks!
>>>>>> -Sam
>>>>>>
>>>>>
>>>>>
>>>>> --
>>>>> Ryan Blue
>>>>> Tabular
>>>>>
>>>>
>>
>> --
>> Ryan Blue
>> Tabular
>>
>
Re: New Versioned Iceberg Documentation Site
Posted by Jack Ye <ye...@gmail.com>.
+1, amazing website! And now the website repo is separated we can continue
to iterate and deploy quickly without affecting the main repo, so no need
to be 100% perfect as of now.
I will update the 0.13 release note against the new website and we can
announce them together.
Best,
Jack Ye
On Tue, Feb 1, 2022 at 8:26 AM Ryan Blue <bl...@tabular.io> wrote:
> Good catch. Looks like the anchor links on the spec page are broken. We'll
> have to get those fixed.
>
> I think we should move forward with the update and fix these as we come
> across them. It's inevitable that we'll have some broken things in a big
> change, but we don't want to block this improvement on being 100% perfect.
>
> On Tue, Feb 1, 2022 at 1:21 AM Ajantha Bhat <aj...@gmail.com> wrote:
>
>> Nice looking website.
>>
>> Is the shared link the final version ? I couldn't see the markdown anchor
>> tag inside https://iceberg.redai.dev/spec/
>> It will be useful to have that for sharing specific parts of the spec.
>>
>> Also some pages are in light theme and some are in dark theme. Better to
>> have a unified theme.
>>
>> +1 for versioning and overall work.
>>
>> Thanks,
>> Ajantha
>>
>> On Tue, Feb 1, 2022 at 1:47 PM Eduard Tudenhoefner <ed...@dremio.com>
>> wrote:
>>
>>> +1 on the procedure and the new site looks amazing
>>>
>>> On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io> wrote:
>>>
>>>> +1 from me. I think the new site looks great and it is a big
>>>> improvement to have version-specific docs. Thanks for all your work on
>>>> this, Sam!
>>>>
>>>> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io> wrote:
>>>>
>>>>> Hey Everyone,
>>>>>
>>>>> With 0.13.0's approval for release, I think this would be a good time
>>>>> to have a discussion around the proposed versioned documentation site,
>>>>> powered by Hugo. The site is ready to be released and the source code for
>>>>> the site can be found in the apache/iceberg-docs repository:
>>>>> https://github.com/apache/iceberg-docs.
>>>>>
>>>>> In order for everyone to see a dev version of the site live, I've
>>>>> deployed it temporarily to: https://iceberg.redai.dev
>>>>>
>>>>> The markdown files will remain in the apache/iceberg repository and
>>>>> will represent the latest unreleased documentation. PRs for changes to
>>>>> documentation will be made against the apache/iceberg repository. During a
>>>>> release, the current version of the docs will be copied from
>>>>> apache/iceberg, to apache/iceberg-docs, where a new version can then be
>>>>> deployed by creating a version branch. With the current configuration, a
>>>>> new version of the documentation site is deployed for each branch name, for
>>>>> example creating an `0.13.0` branch will deploy an `0.13.0` version of the
>>>>> site. A particular version can be reached at /docs/<version>. We will also
>>>>> maintain a `latest` branch which will be a clone of the latest version
>>>>> branch. All links at the top level (such as from the landing-page) will
>>>>> link to the `docs/latest` site.
>>>>>
>>>>> If everyone is ok with this, I'll reach out to the ASF infra team to
>>>>> begin the process.
>>>>>
>>>>> Thanks!
>>>>> -Sam
>>>>>
>>>>
>>>>
>>>> --
>>>> Ryan Blue
>>>> Tabular
>>>>
>>>
>
> --
> Ryan Blue
> Tabular
>
Re: New Versioned Iceberg Documentation Site
Posted by Ryan Blue <bl...@tabular.io>.
Good catch. Looks like the anchor links on the spec page are broken. We'll
have to get those fixed.
I think we should move forward with the update and fix these as we come
across them. It's inevitable that we'll have some broken things in a big
change, but we don't want to block this improvement on being 100% perfect.
On Tue, Feb 1, 2022 at 1:21 AM Ajantha Bhat <aj...@gmail.com> wrote:
> Nice looking website.
>
> Is the shared link the final version ? I couldn't see the markdown anchor
> tag inside https://iceberg.redai.dev/spec/
> It will be useful to have that for sharing specific parts of the spec.
>
> Also some pages are in light theme and some are in dark theme. Better to
> have a unified theme.
>
> +1 for versioning and overall work.
>
> Thanks,
> Ajantha
>
> On Tue, Feb 1, 2022 at 1:47 PM Eduard Tudenhoefner <ed...@dremio.com>
> wrote:
>
>> +1 on the procedure and the new site looks amazing
>>
>> On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io> wrote:
>>
>>> +1 from me. I think the new site looks great and it is a big improvement
>>> to have version-specific docs. Thanks for all your work on this, Sam!
>>>
>>> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io> wrote:
>>>
>>>> Hey Everyone,
>>>>
>>>> With 0.13.0's approval for release, I think this would be a good time
>>>> to have a discussion around the proposed versioned documentation site,
>>>> powered by Hugo. The site is ready to be released and the source code for
>>>> the site can be found in the apache/iceberg-docs repository:
>>>> https://github.com/apache/iceberg-docs.
>>>>
>>>> In order for everyone to see a dev version of the site live, I've
>>>> deployed it temporarily to: https://iceberg.redai.dev
>>>>
>>>> The markdown files will remain in the apache/iceberg repository and
>>>> will represent the latest unreleased documentation. PRs for changes to
>>>> documentation will be made against the apache/iceberg repository. During a
>>>> release, the current version of the docs will be copied from
>>>> apache/iceberg, to apache/iceberg-docs, where a new version can then be
>>>> deployed by creating a version branch. With the current configuration, a
>>>> new version of the documentation site is deployed for each branch name, for
>>>> example creating an `0.13.0` branch will deploy an `0.13.0` version of the
>>>> site. A particular version can be reached at /docs/<version>. We will also
>>>> maintain a `latest` branch which will be a clone of the latest version
>>>> branch. All links at the top level (such as from the landing-page) will
>>>> link to the `docs/latest` site.
>>>>
>>>> If everyone is ok with this, I'll reach out to the ASF infra team to
>>>> begin the process.
>>>>
>>>> Thanks!
>>>> -Sam
>>>>
>>>
>>>
>>> --
>>> Ryan Blue
>>> Tabular
>>>
>>
--
Ryan Blue
Tabular
Re: New Versioned Iceberg Documentation Site
Posted by Ajantha Bhat <aj...@gmail.com>.
Nice looking website.
Is the shared link the final version ? I couldn't see the markdown anchor
tag inside https://iceberg.redai.dev/spec/
It will be useful to have that for sharing specific parts of the spec.
Also some pages are in light theme and some are in dark theme. Better to
have a unified theme.
+1 for versioning and overall work.
Thanks,
Ajantha
On Tue, Feb 1, 2022 at 1:47 PM Eduard Tudenhoefner <ed...@dremio.com>
wrote:
> +1 on the procedure and the new site looks amazing
>
> On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io> wrote:
>
>> +1 from me. I think the new site looks great and it is a big improvement
>> to have version-specific docs. Thanks for all your work on this, Sam!
>>
>> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io> wrote:
>>
>>> Hey Everyone,
>>>
>>> With 0.13.0's approval for release, I think this would be a good time to
>>> have a discussion around the proposed versioned documentation site, powered
>>> by Hugo. The site is ready to be released and the source code for the site
>>> can be found in the apache/iceberg-docs repository:
>>> https://github.com/apache/iceberg-docs.
>>>
>>> In order for everyone to see a dev version of the site live, I've
>>> deployed it temporarily to: https://iceberg.redai.dev
>>>
>>> The markdown files will remain in the apache/iceberg repository and will
>>> represent the latest unreleased documentation. PRs for changes to
>>> documentation will be made against the apache/iceberg repository. During a
>>> release, the current version of the docs will be copied from
>>> apache/iceberg, to apache/iceberg-docs, where a new version can then be
>>> deployed by creating a version branch. With the current configuration, a
>>> new version of the documentation site is deployed for each branch name, for
>>> example creating an `0.13.0` branch will deploy an `0.13.0` version of the
>>> site. A particular version can be reached at /docs/<version>. We will also
>>> maintain a `latest` branch which will be a clone of the latest version
>>> branch. All links at the top level (such as from the landing-page) will
>>> link to the `docs/latest` site.
>>>
>>> If everyone is ok with this, I'll reach out to the ASF infra team to
>>> begin the process.
>>>
>>> Thanks!
>>> -Sam
>>>
>>
>>
>> --
>> Ryan Blue
>> Tabular
>>
>
Re: New Versioned Iceberg Documentation Site
Posted by Eduard Tudenhoefner <ed...@dremio.com>.
+1 on the procedure and the new site looks amazing
On Tue, Feb 1, 2022 at 3:38 AM Ryan Blue <bl...@tabular.io> wrote:
> +1 from me. I think the new site looks great and it is a big improvement
> to have version-specific docs. Thanks for all your work on this, Sam!
>
> On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io> wrote:
>
>> Hey Everyone,
>>
>> With 0.13.0's approval for release, I think this would be a good time to
>> have a discussion around the proposed versioned documentation site, powered
>> by Hugo. The site is ready to be released and the source code for the site
>> can be found in the apache/iceberg-docs repository:
>> https://github.com/apache/iceberg-docs.
>>
>> In order for everyone to see a dev version of the site live, I've
>> deployed it temporarily to: https://iceberg.redai.dev
>>
>> The markdown files will remain in the apache/iceberg repository and will
>> represent the latest unreleased documentation. PRs for changes to
>> documentation will be made against the apache/iceberg repository. During a
>> release, the current version of the docs will be copied from
>> apache/iceberg, to apache/iceberg-docs, where a new version can then be
>> deployed by creating a version branch. With the current configuration, a
>> new version of the documentation site is deployed for each branch name, for
>> example creating an `0.13.0` branch will deploy an `0.13.0` version of the
>> site. A particular version can be reached at /docs/<version>. We will also
>> maintain a `latest` branch which will be a clone of the latest version
>> branch. All links at the top level (such as from the landing-page) will
>> link to the `docs/latest` site.
>>
>> If everyone is ok with this, I'll reach out to the ASF infra team to
>> begin the process.
>>
>> Thanks!
>> -Sam
>>
>
>
> --
> Ryan Blue
> Tabular
>
Re: New Versioned Iceberg Documentation Site
Posted by Ryan Blue <bl...@tabular.io>.
+1 from me. I think the new site looks great and it is a big improvement to
have version-specific docs. Thanks for all your work on this, Sam!
On Mon, Jan 31, 2022 at 5:48 PM Sam Redai <sa...@tabular.io> wrote:
> Hey Everyone,
>
> With 0.13.0's approval for release, I think this would be a good time to
> have a discussion around the proposed versioned documentation site, powered
> by Hugo. The site is ready to be released and the source code for the site
> can be found in the apache/iceberg-docs repository:
> https://github.com/apache/iceberg-docs.
>
> In order for everyone to see a dev version of the site live, I've deployed
> it temporarily to: https://iceberg.redai.dev
>
> The markdown files will remain in the apache/iceberg repository and will
> represent the latest unreleased documentation. PRs for changes to
> documentation will be made against the apache/iceberg repository. During a
> release, the current version of the docs will be copied from
> apache/iceberg, to apache/iceberg-docs, where a new version can then be
> deployed by creating a version branch. With the current configuration, a
> new version of the documentation site is deployed for each branch name, for
> example creating an `0.13.0` branch will deploy an `0.13.0` version of the
> site. A particular version can be reached at /docs/<version>. We will also
> maintain a `latest` branch which will be a clone of the latest version
> branch. All links at the top level (such as from the landing-page) will
> link to the `docs/latest` site.
>
> If everyone is ok with this, I'll reach out to the ASF infra team to begin
> the process.
>
> Thanks!
> -Sam
>
--
Ryan Blue
Tabular