You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@yunikorn.apache.org by Lamber Ken <la...@apache.org> on 2020/06/08 10:32:57 UTC
[DISCUSS] Move documents into the website
Dear community,
Most doc files at master branch, it's unfriendly for readers.
So, spend some time to try to move these docs to site[1], the site is built based on docusaurus V2. it's an initial version, any thoughts?
Best,
Lamber-Ken
[1] https://apacheyunikorn.github.io
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@yunikorn.apache.org
For additional commands, e-mail: dev-help@yunikorn.apache.org
Re: [DISCUSS] Move documents into the website
Posted by Wilfred Spiegelenburg <wi...@apache.org>.
Hi,
Based on the feedback you gave during the community sync using jekyll is
far more complex than using Docusaurus.
We can swap over and move to a different build system if that gives us a
better result. Version 2 seems to be needed if we want versioned
documentation.
If you think it is stable enough to build with then lets try to get it all
moved over.
Looking at what you have build now there are a couple of things left to
answer:
* We have used links inside and from one md file to another md file, do we
need to change the way we define them? On the site you have build the inter
doc links do not work and that could well be due to the way we have done
that or is that something that needs to be done manually.
* How much can be automated of the build? I as an example have no UI and
limited javascript knowledge. Can it be made so simple and fool proof so
that I could even publish a new documentation version?
Hosting on apache.org is a must but that should be possible with the new
build tool also, we just need to figure out what we need to change for that.
We would really appreciate if you could help us get this major change
worked out. We can help move docs from repo to repo and commit things but
would need your expertise on the build and setup.
Weiwei logged a jira for the work. You have been added as a contributor to
the project.
Let us know what else you need from us to get this started.
Wilfred
On Thu, 11 Jun 2020 at 15:17, Weiwei Yang <ww...@apache.org> wrote:
> Based on the community discussion today, I've created JIRA:
> https://issues.apache.org/jira/browse/YUNIKORN-212 to track this effort.
> Thank you so much for the efforts to have the initial version based on
> https://github.com/facebook/docusaurus, I think this is the right
> direction. Let's see how we can rebuild our website with this.
> Moving the direction to the JIRA issue for details.
>
> On Mon, Jun 8, 2020 at 9:30 PM Weiwei Yang <ww...@apache.org> wrote:
>
>> Hi Lamber
>>
>> The website looks really nice, thank you for working on it !!
>> To consolidate this, the best option is to get this work with the
>> existing website: https://github.com/apache/incubator-yunikorn-site.
>> Like Wilfred mentioned, leverages Jekyll to build these pages, not sure how
>> difficult is that.
>> I am also totally flexible to replace that with docusaurus-v2 based
>> website like what is demonstrated here, Seems like most work has already
>> been done. But be aware of the overhead about, e.g how to build this
>> automatically, how to publish under ASF, etc.
>> @Sunil G <su...@apache.org> any thoughts?
>>
>> Thanks
>> Weiwei
>>
>>
>>
>> On Mon, Jun 8, 2020 at 6:43 PM Wilfred Spiegelenburg <wi...@apache.org>
>> wrote:
>>
>>> HI Lamber-Ken,
>>>
>>> The current website (https://yunikorn.apache.org) uses jekyll as the
>>> generator. Jekyll has build in support for md to html conversions.
>>> I did start moving the links over to the website but not the documents
>>> yet.
>>> We should be able to leverage jekyll with the right setup to generate the
>>> pages from the site repository we have. Check the master branch in this
>>> repo: https://github.com/apache/incubator-yunikorn-site
>>> The content of that repo gets published automatically to the web server.
>>>
>>> We should leverage that setup to automate the conversion and generate the
>>> pages. Can that be done?
>>>
>>> Wilfred
>>>
>>> On Mon, 8 Jun 2020 at 20:32, Lamber Ken <la...@apache.org> wrote:
>>>
>>> >
>>> > Dear community,
>>> >
>>> > Most doc files at master branch, it's unfriendly for readers.
>>> >
>>> > So, spend some time to try to move these docs to site[1], the site is
>>> > built based on docusaurus V2. it's an initial version, any thoughts?
>>> >
>>> > Best,
>>> > Lamber-Ken
>>> >
>>> > [1] https://apacheyunikorn.github.io
>>> >
>>> >
>>> >
>>> > ---------------------------------------------------------------------
>>> > To unsubscribe, e-mail: dev-unsubscribe@yunikorn.apache.org
>>> > For additional commands, e-mail: dev-help@yunikorn.apache.org
>>> >
>>> >
>>>
>>
Re: [DISCUSS] Move documents into the website
Posted by Weiwei Yang <ww...@apache.org>.
Based on the community discussion today, I've created JIRA:
https://issues.apache.org/jira/browse/YUNIKORN-212 to track this effort.
Thank you so much for the efforts to have the initial version based on
https://github.com/facebook/docusaurus, I think this is the right
direction. Let's see how we can rebuild our website with this.
Moving the direction to the JIRA issue for details.
On Mon, Jun 8, 2020 at 9:30 PM Weiwei Yang <ww...@apache.org> wrote:
> Hi Lamber
>
> The website looks really nice, thank you for working on it !!
> To consolidate this, the best option is to get this work with the existing
> website: https://github.com/apache/incubator-yunikorn-site. Like Wilfred
> mentioned, leverages Jekyll to build these pages, not sure how difficult is
> that.
> I am also totally flexible to replace that with docusaurus-v2 based
> website like what is demonstrated here, Seems like most work has already
> been done. But be aware of the overhead about, e.g how to build this
> automatically, how to publish under ASF, etc.
> @Sunil G <su...@apache.org> any thoughts?
>
> Thanks
> Weiwei
>
>
>
> On Mon, Jun 8, 2020 at 6:43 PM Wilfred Spiegelenburg <wi...@apache.org>
> wrote:
>
>> HI Lamber-Ken,
>>
>> The current website (https://yunikorn.apache.org) uses jekyll as the
>> generator. Jekyll has build in support for md to html conversions.
>> I did start moving the links over to the website but not the documents
>> yet.
>> We should be able to leverage jekyll with the right setup to generate the
>> pages from the site repository we have. Check the master branch in this
>> repo: https://github.com/apache/incubator-yunikorn-site
>> The content of that repo gets published automatically to the web server.
>>
>> We should leverage that setup to automate the conversion and generate the
>> pages. Can that be done?
>>
>> Wilfred
>>
>> On Mon, 8 Jun 2020 at 20:32, Lamber Ken <la...@apache.org> wrote:
>>
>> >
>> > Dear community,
>> >
>> > Most doc files at master branch, it's unfriendly for readers.
>> >
>> > So, spend some time to try to move these docs to site[1], the site is
>> > built based on docusaurus V2. it's an initial version, any thoughts?
>> >
>> > Best,
>> > Lamber-Ken
>> >
>> > [1] https://apacheyunikorn.github.io
>> >
>> >
>> >
>> > ---------------------------------------------------------------------
>> > To unsubscribe, e-mail: dev-unsubscribe@yunikorn.apache.org
>> > For additional commands, e-mail: dev-help@yunikorn.apache.org
>> >
>> >
>>
>
Re: [DISCUSS] Move documents into the website
Posted by Weiwei Yang <ww...@apache.org>.
Hi Lamber
The website looks really nice, thank you for working on it !!
To consolidate this, the best option is to get this work with the existing
website: https://github.com/apache/incubator-yunikorn-site. Like Wilfred
mentioned, leverages Jekyll to build these pages, not sure how difficult is
that.
I am also totally flexible to replace that with docusaurus-v2 based website
like what is demonstrated here, Seems like most work has already been done.
But be aware of the overhead about, e.g how to build this automatically,
how to publish under ASF, etc.
@Sunil G <su...@apache.org> any thoughts?
Thanks
Weiwei
On Mon, Jun 8, 2020 at 6:43 PM Wilfred Spiegelenburg <wi...@apache.org>
wrote:
> HI Lamber-Ken,
>
> The current website (https://yunikorn.apache.org) uses jekyll as the
> generator. Jekyll has build in support for md to html conversions.
> I did start moving the links over to the website but not the documents yet.
> We should be able to leverage jekyll with the right setup to generate the
> pages from the site repository we have. Check the master branch in this
> repo: https://github.com/apache/incubator-yunikorn-site
> The content of that repo gets published automatically to the web server.
>
> We should leverage that setup to automate the conversion and generate the
> pages. Can that be done?
>
> Wilfred
>
> On Mon, 8 Jun 2020 at 20:32, Lamber Ken <la...@apache.org> wrote:
>
> >
> > Dear community,
> >
> > Most doc files at master branch, it's unfriendly for readers.
> >
> > So, spend some time to try to move these docs to site[1], the site is
> > built based on docusaurus V2. it's an initial version, any thoughts?
> >
> > Best,
> > Lamber-Ken
> >
> > [1] https://apacheyunikorn.github.io
> >
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@yunikorn.apache.org
> > For additional commands, e-mail: dev-help@yunikorn.apache.org
> >
> >
>
Re: [DISCUSS] Move documents into the website
Posted by Wilfred Spiegelenburg <wi...@apache.org>.
HI Lamber-Ken,
The current website (https://yunikorn.apache.org) uses jekyll as the
generator. Jekyll has build in support for md to html conversions.
I did start moving the links over to the website but not the documents yet.
We should be able to leverage jekyll with the right setup to generate the
pages from the site repository we have. Check the master branch in this
repo: https://github.com/apache/incubator-yunikorn-site
The content of that repo gets published automatically to the web server.
We should leverage that setup to automate the conversion and generate the
pages. Can that be done?
Wilfred
On Mon, 8 Jun 2020 at 20:32, Lamber Ken <la...@apache.org> wrote:
>
> Dear community,
>
> Most doc files at master branch, it's unfriendly for readers.
>
> So, spend some time to try to move these docs to site[1], the site is
> built based on docusaurus V2. it's an initial version, any thoughts?
>
> Best,
> Lamber-Ken
>
> [1] https://apacheyunikorn.github.io
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@yunikorn.apache.org
> For additional commands, e-mail: dev-help@yunikorn.apache.org
>
>
Re: [DISCUSS] Move documents into the website
Posted by Weiwei Yang <ww...@apache.org>.
Hi all
I've committed Lamber's patch to
https://github.com/apache/incubator-yunikorn-site/tree/site-v2.
I did some optimizations, and just published the new version website to
http://yunikorn.apache.org/. Please check it out and let me know your
feedback!
BTW, I've enabled the [dark] mode, I am getting used to dark mode for too
long, and I am glad that docusaurus supports it nicely : )
Many thank Lamber for the contribution!
Thanks
On Thu, Jun 11, 2020 at 11:13 AM Weiwei Yang <ww...@apache.org> wrote:
> hi Lamber/Wilfred/Sunil
>
> Thanks a lot.
> Let's work on this together, targeting for v0.9 deliverable.
>
> On Thu, Jun 11, 2020 at 6:13 AM Lamber Ken <la...@apache.org> wrote:
>
>> Thanks you all, plan to work on it.
>>
>> Best,
>> Lamber-Ken
>>
>> On 2020/06/08 10:32:57, Lamber Ken <la...@apache.org> wrote:
>> >
>> > Dear community,
>> >
>> > Most doc files at master branch, it's unfriendly for readers.
>> >
>> > So, spend some time to try to move these docs to site[1], the site is
>> built based on docusaurus V2. it's an initial version, any thoughts?
>> >
>> > Best,
>> > Lamber-Ken
>> >
>> > [1] https://apacheyunikorn.github.io
>> >
>> >
>> >
>> > ---------------------------------------------------------------------
>> > To unsubscribe, e-mail: dev-unsubscribe@yunikorn.apache.org
>> > For additional commands, e-mail: dev-help@yunikorn.apache.org
>> >
>> >
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@yunikorn.apache.org
>> For additional commands, e-mail: dev-help@yunikorn.apache.org
>>
>>
Re: [DISCUSS] Move documents into the website
Posted by Weiwei Yang <ww...@apache.org>.
hi Lamber/Wilfred/Sunil
Thanks a lot.
Let's work on this together, targeting for v0.9 deliverable.
On Thu, Jun 11, 2020 at 6:13 AM Lamber Ken <la...@apache.org> wrote:
> Thanks you all, plan to work on it.
>
> Best,
> Lamber-Ken
>
> On 2020/06/08 10:32:57, Lamber Ken <la...@apache.org> wrote:
> >
> > Dear community,
> >
> > Most doc files at master branch, it's unfriendly for readers.
> >
> > So, spend some time to try to move these docs to site[1], the site is
> built based on docusaurus V2. it's an initial version, any thoughts?
> >
> > Best,
> > Lamber-Ken
> >
> > [1] https://apacheyunikorn.github.io
> >
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@yunikorn.apache.org
> > For additional commands, e-mail: dev-help@yunikorn.apache.org
> >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@yunikorn.apache.org
> For additional commands, e-mail: dev-help@yunikorn.apache.org
>
>
Re: [DISCUSS] Move documents into the website
Posted by Lamber Ken <la...@apache.org>.
Thanks you all, plan to work on it.
Best,
Lamber-Ken
On 2020/06/08 10:32:57, Lamber Ken <la...@apache.org> wrote:
>
> Dear community,
>
> Most doc files at master branch, it's unfriendly for readers.
>
> So, spend some time to try to move these docs to site[1], the site is built based on docusaurus V2. it's an initial version, any thoughts?
>
> Best,
> Lamber-Ken
>
> [1] https://apacheyunikorn.github.io
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@yunikorn.apache.org
> For additional commands, e-mail: dev-help@yunikorn.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@yunikorn.apache.org
For additional commands, e-mail: dev-help@yunikorn.apache.org