We had it auto generating on uber/hudi repo as well. I think its best we figure out automation from get go, given we will be making lots of changes to docs in coming weeks.
thoughts? On Tue, Feb 12, 2019 at 12:00 PM Thomas Weise <[email protected]> wrote: > Well, it won't generate automatically. You would need to run Jekyll to > generate the output in the content directory. > > And you should provide the instructions for that to the community.. > > Later, you can work on CI automation to do that, like you find it in Beam. > > On Tue, Feb 12, 2019 at 11:57 AM Vinoth Chandar <[email protected]> wrote: > > > We landed the initial site yesterday. Its not rendering though.. > > > > I think it will be easier to debug and iterate with write access. > > > > Nishith, any thoughts on why its not rendering? its still showing Thomas' > > "coming soon" placeholder > > > > On Tue, Feb 12, 2019 at 11:54 AM Thomas Weise <[email protected]> wrote: > > > > > Yes, there is some delay, that is synced periodically. So give it a bit > > of > > > time and then check again. > > > > > > BTW any plans to generate the content also :) > > > > > > On Tue, Feb 12, 2019 at 11:46 AM Vinoth Chandar <[email protected]> > > wrote: > > > > > > > The invite takes a while to arrive. So may be an hour or so. > > > > > > > > But, I am wondering if gitbox has its own delays in reading state > back > > > from > > > > GitHub to mark us as Apache project member > > > > > > > > On Tue, Feb 12, 2019 at 11:36 AM [email protected] < > > [email protected]> > > > > wrote: > > > > > > > > > > > > > > I am also not able to add myself as reviewer. In my case, The > gitbox > > > > > linking tool is showing : > > > > > "User not a member of the ASF GitHub organisation. Please make sure > > you > > > > > are a part of the ASF" > > > > > I have added my github user name to https://id.apache.org I have > not > > > > > received a github invite from that organisation. > > > > > > > > > > > > > > > > > > > > On Tuesday, February 12, 2019, 11:17:34 AM PST, Vinoth Chandar > < > > > > > [email protected]> wrote: > > > > > > > > > > After linking gitbox using https://gitbox.apache.org/setup/ , I > got > > > > added > > > > > to the Apache GitHub org. > > > > > But still not reflected on gitbox (and probably why I still can't > get > > > > > access) > > > > > > > > > > I started a new PR with a minor change. > > > > > https://github.com/apache/incubator-hudi/pull/2 > > > > > > > > > > Other committers, do you see that you have write access? > > > > > > > > > > > > > > > > > > > > On Tue, Feb 12, 2019 at 9:44 AM Vinoth Chandar <[email protected]> > > > > wrote: > > > > > > > > > > > I am working through gitbox setup. I think we all missed this. > > Once I > > > > get > > > > > > it working, will respond with steps and later add it to docs.. > > > > > > > > > > > > On Mon, Feb 11, 2019 at 7:47 PM Thomas Weise <[email protected]> > > wrote: > > > > > > > > > > > >> Vinoth, > > > > > >> > > > > > >> When your github account is properly linked, you would be able > to > > > > merge > > > > > >> the > > > > > >> PR from the github UI and you also be assignable as reviewer. > > > > > >> > > > > > >> I would recommend to start documenting the setup for other > folks. > > > That > > > > > >> would fall under committer guidelines. > > > > > >> > > > > > >> Thomas > > > > > >> > > > > > >> > > > > > >> > > > > > >> > > > > > >> On Mon, Feb 11, 2019 at 7:10 PM Suneel Marthi < > > > > [email protected]> > > > > > >> wrote: > > > > > >> > > > > > >> > I was able to merge it > > > > > >> > > > > > > >> > I think u need to logout/login from both github and gitbox for > > the > > > > > >> changes > > > > > >> > to take effect. > > > > > >> > > > > > > >> > On Mon, Feb 11, 2019 at 10:03 PM Vinoth Chandar < > > > [email protected]> > > > > > >> wrote: > > > > > >> > > > > > > >> > > No. That does nt work either. > > > > > >> > > > > > > > >> > > @others , can you see perms to merge this pr? > > > > > >> > > https://github.com/apache/incubator-hudi/pull/1 > > > > > >> > > > > > > > >> > > On Mon, Feb 11, 2019 at 6:56 PM Suneel Marthi < > > > > > >> [email protected]> > > > > > >> > > wrote: > > > > > >> > > > > > > > >> > > > On Mon, Feb 11, 2019 at 9:33 PM Vinoth Chandar < > > > > [email protected] > > > > > > > > > > > >> > > wrote: > > > > > >> > > > > > > > > >> > > > > Nope :(. I have already added my apache email to GitHub. > > > Thats > > > > > >> all it > > > > > >> > > > > should take, right? > > > > > >> > > > > > > > > > >> > > > Not quite, u need to completely logout/login from github > for > > > > that > > > > > >> to be > > > > > >> > > > functional > > > > > >> > > > > > > > > >> > > > > > > > > > >> > > > > https://github.com/apache/incubator-hudi/pull/1 > > > > > >> > > > > > > > > > >> > > > > > > > > > >> > > > > > > > > > >> > > > > On Mon, Feb 11, 2019 at 6:23 PM Suneel Marthi < > > > > > >> > [email protected] > > > > > >> > > > > > > > > >> > > > > wrote: > > > > > >> > > > > > > > > > >> > > > > > u shuld be able to merge PRs Vinoth? doesn't work for > > ya ? > > > > > >> > > > > > > > > > > >> > > > > > > > > > > >> > > > > > On Mon, Feb 11, 2019 at 9:04 PM Vinoth Chandar < > > > > > >> [email protected]> > > > > > >> > > > > wrote: > > > > > >> > > > > > > > > > > >> > > > > > > Mentors, > > > > > >> > > > > > > > > > > > >> > > > > > > Should anyone in PPMC be able to merge PRs on > GitHub? > > I > > > > > don't > > > > > >> > have > > > > > >> > > > > access > > > > > >> > > > > > > to do that for this PR. > > > > > >> > > > > > > > > > > > >> > > > > > > Thanks > > > > > >> > > > > > > Vinoth > > > > > >> > > > > > > > > > > > >> > > > > > > On Mon, Feb 11, 2019 at 12:01 PM Vinoth Chandar < > > > > > >> > > > > > > [email protected]> wrote: > > > > > >> > > > > > > > > > > > >> > > > > > > > Bumpingn this thread again. > > > > > >> > > > > > > > > > > > > >> > > > > > > > Once we reciew and land the PR, it will be easy to > > > make > > > > > >> > > incremental > > > > > >> > > > > > > > changes to reflect new guidelines and docs tooling > > > > > >> > > > > > > > > > > > > >> > > > > > > > On Tue, Feb 5, 2019 at 8:49 AM Vinoth Chandar < > > > > > >> > > > > > > > [email protected]> wrote: > > > > > >> > > > > > > > > > > > > >> > > > > > > >> Great points! Docker definitely could be useful > to > > > > > provide > > > > > >> a > > > > > >> > > > > standard > > > > > >> > > > > > > >> Jekyll, ruby build environment. > > > > > >> > > > > > > >> Something, that Nishith himself had trouble with. > > > > > >> > > > > > > >> > > > > > >> > > > > > > >> On Mon, Feb 4, 2019 at 7:09 AM Thomas Weise < > > > > > >> [email protected]> > > > > > >> > > > wrote: > > > > > >> > > > > > > >> > > > > > >> > > > > > > >>> A pull request is the common way to propose > > changes > > > in > > > > > >> other > > > > > >> > > > > > projects, > > > > > >> > > > > > > so > > > > > >> > > > > > > >>> that's good. > > > > > >> > > > > > > >>> > > > > > >> > > > > > > >>> One of the things you will want to work on going > > > > forward > > > > > >> are > > > > > >> > > > > > > contributor > > > > > >> > > > > > > >>> guidelines that explain this, among other > things. > > > > > >> > > > > > > >>> > > > > > >> > > > > > > >>> Other suggestions (that can all be taken up as > > > > > follow-up, > > > > > >> > > perhaps > > > > > >> > > > > > worth > > > > > >> > > > > > > >>> creating a JIRAs): > > > > > >> > > > > > > >>> - Source file should have license headers > > > > > >> > > > > > > >>> - Take a look at other incubator and top level > > > > projects > > > > > >> for > > > > > >> > web > > > > > >> > > > > site > > > > > >> > > > > > > >>> commonalities such as community / contributing > > > > sections > > > > > >> > > > > > > >>> - Consider adding a README to the web site > sources > > > > > folder > > > > > >> > and a > > > > > >> > > > > build > > > > > >> > > > > > > >>> script that shields developers from error prone > > > manual > > > > > >> steps > > > > > >> > > > > > > >>> - Docker is a good way to avoid having to > install > > > > pieces > > > > > >> on > > > > > >> > the > > > > > >> > > > > host > > > > > >> > > > > > OS > > > > > >> > > > > > > >>> (example: > > > > > >> > > > > > > >>> > > > > > >> > > > > > > >>> > > > > > >> > > > > > > > > > > > >> > > > > > > > > > > >> > > > > > > > > > >> > > > > > > > > >> > > > > > > > >> > > > > > > >> > > > > > > > > > > > > > > > https://flink.apache.org/improve-website.html#update-or-extend-the-documentation > > > > > >> > > > > > > >>> ) > > > > > >> > > > > > > >>> - Maybe in the future you want to separate web > > site > > > > > >> sources > > > > > >> > > from > > > > > >> > > > > > > >>> documentation (since documentation is usually > > > specific > > > > > to > > > > > >> > > > versions) > > > > > >> > > > > > > >>> > > > > > >> > > > > > > >>> Thomas > > > > > >> > > > > > > >>> > > > > > >> > > > > > > >>> > > > > > >> > > > > > > >>> > > > > > >> > > > > > > >>> On Sun, Feb 3, 2019 at 11:05 PM nishith agarwal > < > > > > > >> > > > > [email protected] > > > > > >> > > > > > > > > > > > >> > > > > > > >>> wrote: > > > > > >> > > > > > > >>> > > > > > >> > > > > > > >>> > Hi All, > > > > > >> > > > > > > >>> > > > > > > >> > > > > > > >>> > I've altered the documentation and created a > PR > > > > > against > > > > > >> the > > > > > >> > > > > > > "asf-site" > > > > > >> > > > > > > >>> > branch due to absence of a master branch > > (instead > > > of > > > > > >> > pushing > > > > > >> > > > to a > > > > > >> > > > > > > >>> branch > > > > > >> > > > > > > >>> > directly). In the comments, I've tried to > > explain > > > > the > > > > > >> > > changes I > > > > > >> > > > > > made. > > > > > >> > > > > > > >>> In > > > > > >> > > > > > > >>> > summary, most of our packages, metadata for > > > > datasets, > > > > > >> admin > > > > > >> > > > > client > > > > > >> > > > > > > and > > > > > >> > > > > > > >>> more > > > > > >> > > > > > > >>> > are named with "hoodie". For now, I've just > made > > > > some > > > > > >> > > cosmetic > > > > > >> > > > > name > > > > > >> > > > > > > >>> changes > > > > > >> > > > > > > >>> > in the docs from "hoodie" -> "hudi" since > > > > performing a > > > > > >> > > > widespread > > > > > >> > > > > > > >>> rename > > > > > >> > > > > > > >>> > does not make sense. > > > > > >> > > > > > > >>> > My guess is we can have an initial version of > > the > > > > site > > > > > >> > ready > > > > > >> > > > with > > > > > >> > > > > > > such > > > > > >> > > > > > > >>> > changes, iterate on it and come up with a plan > > as > > > we > > > > > >> > migrate > > > > > >> > > > the > > > > > >> > > > > > > >>> codebase > > > > > >> > > > > > > >>> > but I'd love to hear your thoughts around > this. > > > > > >> > > > > > > >>> > > > > > > >> > > > > > > >>> > Thanks, > > > > > >> > > > > > > >>> > Nishith > > > > > >> > > > > > > >>> > > > > > > >> > > > > > > >>> > On Thu, Jan 31, 2019 at 2:38 PM nishith > agarwal > > < > > > > > >> > > > > > [email protected] > > > > > >> > > > > > > > > > > > > >> > > > > > > >>> > wrote: > > > > > >> > > > > > > >>> > > > > > > >> > > > > > > >>> > > Yes, I'll get to it later tonight. > > > > > >> > > > > > > >>> > > > > > > > >> > > > > > > >>> > > Thanks, > > > > > >> > > > > > > >>> > > Nishith > > > > > >> > > > > > > >>> > > > > > > > >> > > > > > > >>> > > On Thu, Jan 31, 2019 at 1:04 PM Vinoth > > Chandar < > > > > > >> > > > > > [email protected]> > > > > > >> > > > > > > >>> > wrote: > > > > > >> > > > > > > >>> > > > > > > > >> > > > > > > >>> > >> Nishith, are you working on the site? Just > > > wanted > > > > > to > > > > > >> > > confirm > > > > > >> > > > > and > > > > > >> > > > > > > >>> see if > > > > > >> > > > > > > >>> > >> you > > > > > >> > > > > > > >>> > >> need more help from one of us. > > > > > >> > > > > > > >>> > >> > > > > > >> > > > > > > >>> > >> On Thu, Jan 24, 2019 at 8:21 PM Vinoth > > Chandar > > > < > > > > > >> > > > > > > >>> > >> [email protected]> wrote: > > > > > >> > > > > > > >>> > >> > > > > > >> > > > > > > >>> > >> > What thomas says, makes sense to me. For > > now, > > > > we > > > > > >> can > > > > > >> > > just > > > > > >> > > > > > import > > > > > >> > > > > > > >>> site > > > > > >> > > > > > > >>> > >> into > > > > > >> > > > > > > >>> > >> > asf-site and make a call on what we check > > > into > > > > > >> master > > > > > >> > > down > > > > > >> > > > > the > > > > > >> > > > > > > >>> line? > > > > > >> > > > > > > >>> > >> > > > > > > >> > > > > > > >>> > >> > On Thu, Jan 24, 2019 at 8:17 PM Vinoth > > > Chandar > > > > < > > > > > >> > > > > > > >>> > >> > [email protected]> wrote: > > > > > >> > > > > > > >>> > >> > > > > > > >> > > > > > > >>> > >> >> Guess it does nt clutter source code > with > > > > docs, > > > > > >> js, > > > > > >> > css > > > > > >> > > > > etc? > > > > > >> > > > > > > >>> > >> >> > > > > > >> > > > > > > >>> > >> >> On Thu, Jan 24, 2019 at 7:46 PM nishith > > > > agarwal > > > > > < > > > > > >> > > > > > > >>> [email protected] > > > > > >> > > > > > > >>> > > > > > > > >> > > > > > > >>> > >> >> wrote: > > > > > >> > > > > > > >>> > >> >> > > > > > >> > > > > > > >>> > >> >>> I vote for #3 as well. Yes, I'll take > up > > > the > > > > > >> lead on > > > > > >> > > > this. > > > > > >> > > > > > > >>> > >> >>> BTW, why is creating a separate branch > > > > > >> (asf-site) so > > > > > >> > > > > > popular ? > > > > > >> > > > > > > >>> I see > > > > > >> > > > > > > >>> > >> that > > > > > >> > > > > > > >>> > >> >>> many projects have done that. > > > > > >> > > > > > > >>> > >> >>> > > > > > >> > > > > > > >>> > >> >>> Thanks, > > > > > >> > > > > > > >>> > >> >>> Nishith > > > > > >> > > > > > > >>> > >> >>> > > > > > >> > > > > > > >>> > >> >>> On Thu, Jan 24, 2019 at 2:13 PM Anbu > > > > Cheeralan > > > > > < > > > > > >> > > > > > > >>> [email protected]> > > > > > >> > > > > > > >>> > >> >>> wrote: > > > > > >> > > > > > > >>> > >> >>> > > > > > >> > > > > > > >>> > >> >>> > I prefer #3 that will keep the > > > > documentation > > > > > >> > in-sync > > > > > >> > > > > with > > > > > >> > > > > > > the > > > > > >> > > > > > > >>> > code. > > > > > >> > > > > > > >>> > >> >>> > > > > > > >> > > > > > > >>> > >> >>> > On 2019/01/24 21:27:39, Vinoth > Chandar > > < > > > > > >> > > > > > > >>> > >> [email protected]> > > > > > >> > > > > > > >>> > >> >>> > wrote: > > > > > >> > > > > > > >>> > >> >>> > > Hello all, > > > > > >> > > > > > > >>> > >> >>> > > > > > > > >> > > > > > > >>> > >> >>> > > Just summarizing how the current > > > project > > > > > >> > > > documentation > > > > > >> > > > > > is > > > > > >> > > > > > > >>> setup > > > > > >> > > > > > > >>> > >> and > > > > > >> > > > > > > >>> > >> >>> then > > > > > >> > > > > > > >>> > >> >>> > > use this thread to discuss how we > > want > > > to > > > > > >> > proceed. > > > > > >> > > > Its > > > > > >> > > > > > > >>> based on > > > > > >> > > > > > > >>> > >> >>> Jekyll > > > > > >> > > > > > > >>> > >> >>> > and > > > > > >> > > > > > > >>> > >> >>> > > markup.To build Hudi docs, you just > > > need > > > > to > > > > > >> > > install > > > > > >> > > > > > > >>> gem/ruby set > > > > > >> > > > > > > >>> > >> and > > > > > >> > > > > > > >>> > >> >>> spin > > > > > >> > > > > > > >>> > >> >>> > > up Jekyll. > > > > > >> > > > > > > >>> > >> >>> > > > > > > > >> > > > > > > > https://idratherbewriting.com/documentation-theme-jekyll/ > > > > > >> > > > > > > >>> has > > > > > >> > > > > > > >>> > >> >>> > > instructions. > > > > > >> > > > > > > >>> > >> >>> > > > > > > > >> > > > > > > >>> > >> >>> > > We have a few options to manage > docs. > > > > > >> > > > > > > >>> > >> >>> > > > > > > > >> > > > > > > >>> > >> >>> > > 1. Separate repo (away from source > > > code) > > > > > >> > > > > > > >>> > >> >>> > > 2. Special branch along with code > > > > (asf-site > > > > > >> > branch > > > > > >> > > > > here > > > > > >> > > > > > > >>> > >> >>> > > > > > https://github.com/apache/incubator-hudi > > > > ) > > > > > >> > > > > > > >>> > >> >>> > > 3. Checked into a top level docs > > folder > > > > on > > > > > >> all > > > > > >> > > > > branches > > > > > >> > > > > > > >>> (current > > > > > >> > > > > > > >>> > >> >>> > approach) > > > > > >> > > > > > > >>> > >> >>> > > > > > > > >> > > > > > > >>> > >> >>> > > I vote for #3. I have do #2 on a > > > previous > > > > > >> open > > > > > >> > > > source > > > > > >> > > > > > > >>> project > > > > > >> > > > > > > >>> > and > > > > > >> > > > > > > >>> > >> the > > > > > >> > > > > > > >>> > >> >>> > code > > > > > >> > > > > > > >>> > >> >>> > > kept diverging from docs. > > > > > >> > > > > > > >>> > >> >>> > > > > > > > >> > > > > > > >>> > >> >>> > > What do you all think? > > > > > >> > > > > > > >>> > >> >>> > > > > > > > >> > > > > > > >>> > >> >>> > > Nishith, can you confirm you are > > taking > > > > the > > > > > >> lead > > > > > >> > > on > > > > > >> > > > > > this? > > > > > >> > > > > > > >>> > >> >>> > > > > > > > >> > > > > > > >>> > >> >>> > > Thanks > > > > > >> > > > > > > >>> > >> >>> > > Vinoth > > > > > >> > > > > > > >>> > >> >>> > > > > > > > >> > > > > > > >>> > >> >>> > > > > > > >> > > > > > > >>> > >> >>> > > > > > >> > > > > > > >>> > >> >> > > > > > >> > > > > > > >>> > >> > > > > > >> > > > > > > >>> > > > > > > > >> > > > > > > >>> > > > > > > >> > > > > > > >>> > > > > > >> > > > > > > >> > > > > > >> > > > > > > > > > > > >> > > > > > > > > > > >> > > > > > > > > > >> > > > > > > > > >> > > > > > > > >> > > > > > > >> > > > > > > > > > > > > > > > > > > > > >
