Thanks, JB, for your efforts on this. I’ve just realized that we currently have three active documentation build and publish tools in use, which is making the process unnecessarily complex and confusing. We will need to converge these into a single solution as soon as possible to unblock doc publishing.
Here are the options we’re working with: 1. Apache Polaris Site <https://github.com/apache/polaris-site>, which uses *Docusaurus* to build and publish to the site polaris.apache.org. 2. *Redocly*, a doc build tool in the current repo: Polaris Repo <https://github.com/apache/polaris>. 3. *Hugo*, which is in progress in a WIP PR: PR 279 <https://github.com/apache/polaris/pull/279>. After searching around, it seems to me that Hugo is a strong choice without a separated docs git repo. I'd consider this a blocker for the first release. Let me know what you think. Yufei On Mon, Sep 23, 2024 at 7:48 AM Jean-Baptiste Onofré <j...@nanthrax.net> wrote: > Awesome, thanks John ! > > Regards > JB > > On Mon, Sep 23, 2024 at 3:05 PM John Roesler <vvcep...@apache.org> wrote: > > > > Thanks for tackling that, JB! > > > > I approved the PR. > > -John > > > > On Mon, Sep 23, 2024, at 03:47, Jean-Baptiste Onofré wrote: > > > Hi folks, > > > > > > I deployed a new website version including the last merges. > > > > > > I also created a PR with GitHub Actions for: > > > - test website changes (ci) > > > - automatically deploy website when a merge is done on the main branch > (deploy) > > > > > > Here's the PR: https://github.com/apache/polaris-site/pull/6 > > > > > > Regards > > > JB > > > > > > On Fri, Sep 20, 2024 at 6:50 PM Yufei Gu <flyrain...@gmail.com> wrote: > > >> > > >> Thanks a lot, JB! The automatic publishing will help us a lot, given > a high demand for documentation improvements. > > >> > > >> Yufei > > >> > > >> > > >> On Fri, Sep 20, 2024 at 9:06 AM Jean-Baptiste Onofré <j...@nanthrax.net> > wrote: > > >>> > > >>> Hi Yufei > > >>> > > >>> I published the website but Aihua's PR is on the polaris repo, not > the > > >>> polaris-site repo. > > >>> So, I will: > > >>> 1. Sync the doc on polaris-site > > >>> 2. Fix the "WARNING" and "IMPORTANT" formatting style > > >>> 3. Republish website > > >>> > > >>> Then I will do the PR for the GitHub Action to automatically publish > > >>> the website. > > >>> > > >>> Regards > > >>> JB > > >>> > > >>> On Fri, Sep 20, 2024 at 4:48 PM Jean-Baptiste Onofré < > j...@nanthrax.net> wrote: > > >>> > > > >>> > Hi Yufei > > >>> > > > >>> > My bad, I forgot to open the PR. > > >>> > > > >>> > Let me do two things: > > >>> > 1. let me update the website right now > > >>> > 2. let me create the PR > > >>> > > > >>> > Sorry, I was busy in London with Chill Data Summit and Big Data > LDN. > > >>> > > > >>> > Stay tuned ! > > >>> > > > >>> > Regards > > >>> > JB > > >>> > > > >>> > On Wed, Sep 18, 2024 at 11:05 PM Yufei Gu <flyrain...@gmail.com> > wrote: > > >>> > > > > >>> > > Hi team, > > >>> > > > > >>> > > Do we have any update on automatic publishing? We merged Aihua's > doc PR( > > >>> > > https://github.com/apache/polaris/pull/296) yesterday. How can > we make it > > >>> > > available on the site(https://polaris.apache.org/)? > > >>> > > > > >>> > > Yufei > > >>> > > > > >>> > > > > >>> > > On Tue, Sep 10, 2024 at 5:56 PM Don Bosco Durai < > bo...@apache.org> wrote: > > >>> > > > > >>> > > > JB, thanks for merging. Next time I will create the issues in > the > > >>> > > > appropriate repos > > >>> > > > > > >>> > > > On Tue, Sep 10, 2024 at 12:43 AM Jean-Baptiste Onofré < > j...@nanthrax.net> > > >>> > > > wrote: > > >>> > > > > > >>> > > > > Hi, > > >>> > > > > > > >>> > > > > The website related issue should be create on the right > repository: > > >>> > > > > https://github.com/apache/polaris-site/issues > > >>> > > > > > > >>> > > > > I merged your PR, I'm publishing a new version of the > website. > > >>> > > > > > > >>> > > > > Thanks ! > > >>> > > > > Regards > > >>> > > > > JB > > >>> > > > > > > >>> > > > > On Mon, Sep 9, 2024 at 10:45 PM Don Bosco Durai < > bo...@apache.org> > > >>> > > > wrote: > > >>> > > > > > > > >>> > > > > > Where is the source main site and how is it built? There > is a typo in > > >>> > > > the > > >>> > > > > > copyright (at the bottom) https://polaris.apache.org/ > > >>> > > > > > > > >>> > > > > > https://github.com/apache/polaris/issues/275 > > >>> > > > > > > > >>> > > > > > I am happy to fix it if it is needed. > > >>> > > > > > > > >>> > > > > > On Mon, Sep 9, 2024 at 7:54 AM Jean-Baptiste Onofré < > j...@nanthrax.net> > > >>> > > > > wrote: > > >>> > > > > > > > >>> > > > > > > Hi Dmitri, > > >>> > > > > > > > > >>> > > > > > > Basically, docusaurus generates the website in the build > folder. This > > >>> > > > > > > build folder is "copied" into the asf-site branch, this > branch is > > >>> > > > used > > >>> > > > > > > as base for polaris.apache.org (yarn deploy can do it > all in a row > > >>> > > > for > > >>> > > > > > > you). > > >>> > > > > > > I will do the publication as it needs committer > privilege. > > >>> > > > > > > > > >>> > > > > > > Regards > > >>> > > > > > > JB > > >>> > > > > > > > > >>> > > > > > > On Mon, Sep 9, 2024 at 3:52 PM Dmitri Bourlatchkov > > >>> > > > > > > <dmitri.bourlatch...@dremio.com.invalid> wrote: > > >>> > > > > > > > > > >>> > > > > > > > Hi all, > > >>> > > > > > > > > > >>> > > > > > > > How often do we rebuild the polaris.apache.org site? > > >>> > > > > > > > > > >>> > > > > > > > I'm particularly interested in [1] (thanks, JB, for > merging it). > > >>> > > > It's > > >>> > > > > > > not a > > >>> > > > > > > > huge concern, but I think it is important to get users > on the right > > >>> > > > > track > > >>> > > > > > > > from the beginning to minimize upgrade hurdles when we > have a > > >>> > > > > release. > > >>> > > > > > > > > > >>> > > > > > > > Thanks, > > >>> > > > > > > > Dmitri. > > >>> > > > > > > > > > >>> > > > > > > > [1] https://github.com/apache/polaris-site/pull/2 > > >>> > > > > > > > > >>> > > > > > > >>> > > > >
