You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@apisix.apache.org by Nirojan Selvanathan <ss...@gmail.com> on 2020/07/16 19:05:59 UTC

[Discuss] Host APISIX docs generated by Docsify

Hello All,

The docs of APISIX has been recently refactored to autogenerate
<https://docsify.js.org/#/> a webpage by parsing the APISIX markdown files.

The following URL shows how it will look like:
- https://sshniro.github.io/apisix-docsify/#/

In order make this useful for the community can we host this under the
APISIX website domain? The deployment should be fairly simple by deploying
the contents of the doc folder to the server and does not involve any
compilation steps.

Furthermore, can we also setup GitHub actions to auto-deploy the site after
any changes to the docs?

-- 
Best Regards,
S.Nirojan
Linked-in <https://www.linkedin.com/in/niroselva/>

Re: [Discuss] Host APISIX docs generated by Docsify

Posted by 聂永 <ni...@staff.weibo.com>.
Maybe, you need add the ci action when git tag triggering, then produce the version docs.

> 2020年7月17日 15:53,YuanSheng Wang <me...@apache.org> 写道:
> 
> I think that only documents that have been released through Apache, such as
> versions 1.3 and 1.4,
> can be displayed on the website.
> 
> We can not display the documentation of the "master" branch on the website.
> 
> 
> On Fri, Jul 17, 2020 at 2:52 PM Nirojan Selvanathan <ss...@gmail.com>
> wrote:
> 
>> Hi Zhiyuan,
>> 
>> Thank you for the information. I will try to modify the website repository
>> to include the docs folder when deploying the site to GitHub pages.
>> I assume a corn job-based deployment would resolve the continuous
>> deployment problem for now I presume?
>> 
>> On Thu, Jul 16, 2020 at 11:02 PM Zhiyuan Ju <ju...@apache.org> wrote:
>> 
>>> Hi, sshniro,
>>> 
>>> It’s a nice document site for me.
>>> 
>>> The apisix.apache.org is auto deployed when any changes pushed to master
>>> branch, and all generated files are under the ASF branch, not sure if we
>>> could trigger the docs only deployment.
>>> 
>>> We may get some suggestions from Ming :)
>>> 
>>> Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五上午3:06写道:
>>> 
>>>> Hello All,
>>>> 
>>>> The docs of APISIX has been recently refactored to autogenerate
>>>> <https://docsify.js.org/#/> a webpage by parsing the APISIX markdown
>>>> files.
>>>> 
>>>> The following URL shows how it will look like:
>>>> - https://sshniro.github.io/apisix-docsify/#/
>>>> 
>>>> In order make this useful for the community can we host this under the
>>>> APISIX website domain? The deployment should be fairly simple by
>>> deploying
>>>> the contents of the doc folder to the server and does not involve any
>>>> compilation steps.
>>>> 
>>>> Furthermore, can we also setup GitHub actions to auto-deploy the site
>>> after
>>>> any changes to the docs?
>>>> 
>>>> --
>>>> Best Regards,
>>>> S.Nirojan
>>>> Linked-in <https://www.linkedin.com/in/niroselva/>
>>>> 
>>> --
>>> 来自 琚致远
>>> 
>> 
>> 
>> --
>> Best Regards,
>> S.Nirojan
>> Linked-in <https://www.linkedin.com/in/niroselva/>
>> 
> 
> 
> -- 
> 
> *MembPhis*
> My GitHub: https://github.com/membphis
> Apache APISIX: https://github.com/apache/incubator-apisix


Re: [Discuss] Host APISIX docs generated by Docsify

Posted by YuanSheng Wang <me...@apache.org>.
I think that only documents that have been released through Apache, such as
versions 1.3 and 1.4,
can be displayed on the website.

We can not display the documentation of the "master" branch on the website.


On Fri, Jul 17, 2020 at 2:52 PM Nirojan Selvanathan <ss...@gmail.com>
wrote:

> Hi Zhiyuan,
>
> Thank you for the information. I will try to modify the website repository
> to include the docs folder when deploying the site to GitHub pages.
> I assume a corn job-based deployment would resolve the continuous
> deployment problem for now I presume?
>
> On Thu, Jul 16, 2020 at 11:02 PM Zhiyuan Ju <ju...@apache.org> wrote:
>
> > Hi, sshniro,
> >
> > It’s a nice document site for me.
> >
> > The apisix.apache.org is auto deployed when any changes pushed to master
> > branch, and all generated files are under the ASF branch, not sure if we
> > could trigger the docs only deployment.
> >
> > We may get some suggestions from Ming :)
> >
> > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五上午3:06写道:
> >
> > > Hello All,
> > >
> > > The docs of APISIX has been recently refactored to autogenerate
> > > <https://docsify.js.org/#/> a webpage by parsing the APISIX markdown
> > > files.
> > >
> > > The following URL shows how it will look like:
> > > - https://sshniro.github.io/apisix-docsify/#/
> > >
> > > In order make this useful for the community can we host this under the
> > > APISIX website domain? The deployment should be fairly simple by
> > deploying
> > > the contents of the doc folder to the server and does not involve any
> > > compilation steps.
> > >
> > > Furthermore, can we also setup GitHub actions to auto-deploy the site
> > after
> > > any changes to the docs?
> > >
> > > --
> > > Best Regards,
> > > S.Nirojan
> > > Linked-in <https://www.linkedin.com/in/niroselva/>
> > >
> > --
> > 来自 琚致远
> >
>
>
> --
> Best Regards,
> S.Nirojan
> Linked-in <https://www.linkedin.com/in/niroselva/>
>


-- 

*MembPhis*
My GitHub: https://github.com/membphis
Apache APISIX: https://github.com/apache/incubator-apisix

Re: [Discuss] Host APISIX docs generated by Docsify

Posted by Zhiyuan Ju <ju...@apache.org>.
Hi,

The Website for Apache APISIX[1] has been refactored with Docusaurus[2], so
could we migrate APISIX's docs to the website[3]? or we should still keep
markdown files in Apache APISIX's repository[4]?

[1] https://apisix.apache.org/docs/subscrbe-guide/
[2] https://docusaurus.io/
[3] https://github.com/apache/apisix-website
[4] https://github.com/apache/apisix

Best Regards!
@ Zhiyuan Ju <https://www.shaoyaoju.org/>


Zhiyuan Ju <ju...@apache.org> 于2020年8月12日周三 下午8:58写道:

> Hi,
>
> Any updates about this feature?
>
> Best Regards!
> @ Zhiyuan Ju <https://www.shaoyaoju.org/>
>
>
> Nirojan Selvanathan <ss...@gmail.com> 于2020年7月29日周三 下午5:59写道:
>
>> Hi,
>>
>> I've been occupied during the last weeks, I'll try this during the weekend
>> and get back.
>>
>> On Thu, Jul 23, 2020 at 5:29 AM Zhiyuan Ju <ju...@apache.org> wrote:
>>
>> > Hi,
>> >
>> > Any updates here?
>> >
>> > Zhiyuan Ju <ju...@apache.org>于2020年7月17日 周五下午9:20写道:
>> >
>> > > OK!
>> > >
>> > > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五下午9:07写道:
>> > >
>> > >> Thank you for the suggestions, Yes, I will target with deploying the
>> > last
>> > >> released version of APISIX.
>> > >>
>> > >> @Zhiyuan: Sure, I will try to integrate with Hugo first and will get
>> > back
>> > >> to you if I face any problems.
>> > >>
>> > >> On Fri, Jul 17, 2020 at 12:52 PM Zhiyuan Ju <ju...@apache.org>
>> > wrote:
>> > >>
>> > >> > If it’s difficult to connect Docsify with Hugo, we may consider
>> > >> refactoring
>> > >> > the website with new architecture, use Vue.js for both website and
>> > docs
>> > >> for
>> > >> > example.
>> > >> >
>> > >> > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五下午2:52写道:
>> > >> >
>> > >> > > Hi Zhiyuan,
>> > >> > >
>> > >> > > Thank you for the information. I will try to modify the website
>> > >> > repository
>> > >> > > to include the docs folder when deploying the site to GitHub
>> pages.
>> > >> > > I assume a corn job-based deployment would resolve the continuous
>> > >> > > deployment problem for now I presume?
>> > >> > >
>> > >> > > On Thu, Jul 16, 2020 at 11:02 PM Zhiyuan Ju <
>> juzhiyuan@apache.org>
>> > >> > wrote:
>> > >> > >
>> > >> > > > Hi, sshniro,
>> > >> > > >
>> > >> > > > It’s a nice document site for me.
>> > >> > > >
>> > >> > > > The apisix.apache.org is auto deployed when any changes
>> pushed to
>> > >> > master
>> > >> > > > branch, and all generated files are under the ASF branch, not
>> sure
>> > >> if
>> > >> > we
>> > >> > > > could trigger the docs only deployment.
>> > >> > > >
>> > >> > > > We may get some suggestions from Ming :)
>> > >> > > >
>> > >> > > > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五上午3:06写道:
>> > >> > > >
>> > >> > > > > Hello All,
>> > >> > > > >
>> > >> > > > > The docs of APISIX has been recently refactored to
>> autogenerate
>> > >> > > > > <https://docsify.js.org/#/> a webpage by parsing the APISIX
>> > >> markdown
>> > >> > > > > files.
>> > >> > > > >
>> > >> > > > > The following URL shows how it will look like:
>> > >> > > > > - https://sshniro.github.io/apisix-docsify/#/
>> > >> > > > >
>> > >> > > > > In order make this useful for the community can we host this
>> > under
>> > >> > the
>> > >> > > > > APISIX website domain? The deployment should be fairly
>> simple by
>> > >> > > > deploying
>> > >> > > > > the contents of the doc folder to the server and does not
>> > involve
>> > >> any
>> > >> > > > > compilation steps.
>> > >> > > > >
>> > >> > > > > Furthermore, can we also setup GitHub actions to auto-deploy
>> the
>> > >> site
>> > >> > > > after
>> > >> > > > > any changes to the docs?
>> > >> > > > >
>> > >> > > > > --
>> > >> > > > > Best Regards,
>> > >> > > > > S.Nirojan
>> > >> > > > > Linked-in <https://www.linkedin.com/in/niroselva/>
>> > >> > > > >
>> > >> > > > --
>> > >> > > > 来自 琚致远
>> > >> > > >
>> > >> > >
>> > >> > >
>> > >> > > --
>> > >> > > Best Regards,
>> > >> > > S.Nirojan
>> > >> > > Linked-in <https://www.linkedin.com/in/niroselva/>
>> > >> > >
>> > >> > --
>> > >> > 来自 琚致远
>> > >> >
>> > >>
>> > >>
>> > >> --
>> > >> Best Regards,
>> > >> S.Nirojan
>> > >> Linked-in <https://www.linkedin.com/in/niroselva/>
>> > >>
>> > > --
>> > > 来自 琚致远
>> > >
>> > --
>> > 来自 琚致远
>> >
>>
>>
>> --
>> Best Regards,
>> S.Nirojan
>> Linked-in <https://www.linkedin.com/in/niroselva/>
>>
>

Re: [Discuss] Host APISIX docs generated by Docsify

Posted by Zhiyuan Ju <ju...@apache.org>.
Hi,

Any updates about this feature?

Best Regards!
@ Zhiyuan Ju <https://www.shaoyaoju.org/>


Nirojan Selvanathan <ss...@gmail.com> 于2020年7月29日周三 下午5:59写道:

> Hi,
>
> I've been occupied during the last weeks, I'll try this during the weekend
> and get back.
>
> On Thu, Jul 23, 2020 at 5:29 AM Zhiyuan Ju <ju...@apache.org> wrote:
>
> > Hi,
> >
> > Any updates here?
> >
> > Zhiyuan Ju <ju...@apache.org>于2020年7月17日 周五下午9:20写道:
> >
> > > OK!
> > >
> > > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五下午9:07写道:
> > >
> > >> Thank you for the suggestions, Yes, I will target with deploying the
> > last
> > >> released version of APISIX.
> > >>
> > >> @Zhiyuan: Sure, I will try to integrate with Hugo first and will get
> > back
> > >> to you if I face any problems.
> > >>
> > >> On Fri, Jul 17, 2020 at 12:52 PM Zhiyuan Ju <ju...@apache.org>
> > wrote:
> > >>
> > >> > If it’s difficult to connect Docsify with Hugo, we may consider
> > >> refactoring
> > >> > the website with new architecture, use Vue.js for both website and
> > docs
> > >> for
> > >> > example.
> > >> >
> > >> > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五下午2:52写道:
> > >> >
> > >> > > Hi Zhiyuan,
> > >> > >
> > >> > > Thank you for the information. I will try to modify the website
> > >> > repository
> > >> > > to include the docs folder when deploying the site to GitHub
> pages.
> > >> > > I assume a corn job-based deployment would resolve the continuous
> > >> > > deployment problem for now I presume?
> > >> > >
> > >> > > On Thu, Jul 16, 2020 at 11:02 PM Zhiyuan Ju <juzhiyuan@apache.org
> >
> > >> > wrote:
> > >> > >
> > >> > > > Hi, sshniro,
> > >> > > >
> > >> > > > It’s a nice document site for me.
> > >> > > >
> > >> > > > The apisix.apache.org is auto deployed when any changes pushed
> to
> > >> > master
> > >> > > > branch, and all generated files are under the ASF branch, not
> sure
> > >> if
> > >> > we
> > >> > > > could trigger the docs only deployment.
> > >> > > >
> > >> > > > We may get some suggestions from Ming :)
> > >> > > >
> > >> > > > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五上午3:06写道:
> > >> > > >
> > >> > > > > Hello All,
> > >> > > > >
> > >> > > > > The docs of APISIX has been recently refactored to
> autogenerate
> > >> > > > > <https://docsify.js.org/#/> a webpage by parsing the APISIX
> > >> markdown
> > >> > > > > files.
> > >> > > > >
> > >> > > > > The following URL shows how it will look like:
> > >> > > > > - https://sshniro.github.io/apisix-docsify/#/
> > >> > > > >
> > >> > > > > In order make this useful for the community can we host this
> > under
> > >> > the
> > >> > > > > APISIX website domain? The deployment should be fairly simple
> by
> > >> > > > deploying
> > >> > > > > the contents of the doc folder to the server and does not
> > involve
> > >> any
> > >> > > > > compilation steps.
> > >> > > > >
> > >> > > > > Furthermore, can we also setup GitHub actions to auto-deploy
> the
> > >> site
> > >> > > > after
> > >> > > > > any changes to the docs?
> > >> > > > >
> > >> > > > > --
> > >> > > > > Best Regards,
> > >> > > > > S.Nirojan
> > >> > > > > Linked-in <https://www.linkedin.com/in/niroselva/>
> > >> > > > >
> > >> > > > --
> > >> > > > 来自 琚致远
> > >> > > >
> > >> > >
> > >> > >
> > >> > > --
> > >> > > Best Regards,
> > >> > > S.Nirojan
> > >> > > Linked-in <https://www.linkedin.com/in/niroselva/>
> > >> > >
> > >> > --
> > >> > 来自 琚致远
> > >> >
> > >>
> > >>
> > >> --
> > >> Best Regards,
> > >> S.Nirojan
> > >> Linked-in <https://www.linkedin.com/in/niroselva/>
> > >>
> > > --
> > > 来自 琚致远
> > >
> > --
> > 来自 琚致远
> >
>
>
> --
> Best Regards,
> S.Nirojan
> Linked-in <https://www.linkedin.com/in/niroselva/>
>

Re: [Discuss] Host APISIX docs generated by Docsify

Posted by Nirojan Selvanathan <ss...@gmail.com>.
Hi,

I've been occupied during the last weeks, I'll try this during the weekend
and get back.

On Thu, Jul 23, 2020 at 5:29 AM Zhiyuan Ju <ju...@apache.org> wrote:

> Hi,
>
> Any updates here?
>
> Zhiyuan Ju <ju...@apache.org>于2020年7月17日 周五下午9:20写道:
>
> > OK!
> >
> > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五下午9:07写道:
> >
> >> Thank you for the suggestions, Yes, I will target with deploying the
> last
> >> released version of APISIX.
> >>
> >> @Zhiyuan: Sure, I will try to integrate with Hugo first and will get
> back
> >> to you if I face any problems.
> >>
> >> On Fri, Jul 17, 2020 at 12:52 PM Zhiyuan Ju <ju...@apache.org>
> wrote:
> >>
> >> > If it’s difficult to connect Docsify with Hugo, we may consider
> >> refactoring
> >> > the website with new architecture, use Vue.js for both website and
> docs
> >> for
> >> > example.
> >> >
> >> > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五下午2:52写道:
> >> >
> >> > > Hi Zhiyuan,
> >> > >
> >> > > Thank you for the information. I will try to modify the website
> >> > repository
> >> > > to include the docs folder when deploying the site to GitHub pages.
> >> > > I assume a corn job-based deployment would resolve the continuous
> >> > > deployment problem for now I presume?
> >> > >
> >> > > On Thu, Jul 16, 2020 at 11:02 PM Zhiyuan Ju <ju...@apache.org>
> >> > wrote:
> >> > >
> >> > > > Hi, sshniro,
> >> > > >
> >> > > > It’s a nice document site for me.
> >> > > >
> >> > > > The apisix.apache.org is auto deployed when any changes pushed to
> >> > master
> >> > > > branch, and all generated files are under the ASF branch, not sure
> >> if
> >> > we
> >> > > > could trigger the docs only deployment.
> >> > > >
> >> > > > We may get some suggestions from Ming :)
> >> > > >
> >> > > > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五上午3:06写道:
> >> > > >
> >> > > > > Hello All,
> >> > > > >
> >> > > > > The docs of APISIX has been recently refactored to autogenerate
> >> > > > > <https://docsify.js.org/#/> a webpage by parsing the APISIX
> >> markdown
> >> > > > > files.
> >> > > > >
> >> > > > > The following URL shows how it will look like:
> >> > > > > - https://sshniro.github.io/apisix-docsify/#/
> >> > > > >
> >> > > > > In order make this useful for the community can we host this
> under
> >> > the
> >> > > > > APISIX website domain? The deployment should be fairly simple by
> >> > > > deploying
> >> > > > > the contents of the doc folder to the server and does not
> involve
> >> any
> >> > > > > compilation steps.
> >> > > > >
> >> > > > > Furthermore, can we also setup GitHub actions to auto-deploy the
> >> site
> >> > > > after
> >> > > > > any changes to the docs?
> >> > > > >
> >> > > > > --
> >> > > > > Best Regards,
> >> > > > > S.Nirojan
> >> > > > > Linked-in <https://www.linkedin.com/in/niroselva/>
> >> > > > >
> >> > > > --
> >> > > > 来自 琚致远
> >> > > >
> >> > >
> >> > >
> >> > > --
> >> > > Best Regards,
> >> > > S.Nirojan
> >> > > Linked-in <https://www.linkedin.com/in/niroselva/>
> >> > >
> >> > --
> >> > 来自 琚致远
> >> >
> >>
> >>
> >> --
> >> Best Regards,
> >> S.Nirojan
> >> Linked-in <https://www.linkedin.com/in/niroselva/>
> >>
> > --
> > 来自 琚致远
> >
> --
> 来自 琚致远
>


-- 
Best Regards,
S.Nirojan
Linked-in <https://www.linkedin.com/in/niroselva/>

Re: [Discuss] Host APISIX docs generated by Docsify

Posted by Zhiyuan Ju <ju...@apache.org>.
Hi,

Any updates here?

Zhiyuan Ju <ju...@apache.org>于2020年7月17日 周五下午9:20写道:

> OK!
>
> Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五下午9:07写道:
>
>> Thank you for the suggestions, Yes, I will target with deploying the last
>> released version of APISIX.
>>
>> @Zhiyuan: Sure, I will try to integrate with Hugo first and will get back
>> to you if I face any problems.
>>
>> On Fri, Jul 17, 2020 at 12:52 PM Zhiyuan Ju <ju...@apache.org> wrote:
>>
>> > If it’s difficult to connect Docsify with Hugo, we may consider
>> refactoring
>> > the website with new architecture, use Vue.js for both website and docs
>> for
>> > example.
>> >
>> > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五下午2:52写道:
>> >
>> > > Hi Zhiyuan,
>> > >
>> > > Thank you for the information. I will try to modify the website
>> > repository
>> > > to include the docs folder when deploying the site to GitHub pages.
>> > > I assume a corn job-based deployment would resolve the continuous
>> > > deployment problem for now I presume?
>> > >
>> > > On Thu, Jul 16, 2020 at 11:02 PM Zhiyuan Ju <ju...@apache.org>
>> > wrote:
>> > >
>> > > > Hi, sshniro,
>> > > >
>> > > > It’s a nice document site for me.
>> > > >
>> > > > The apisix.apache.org is auto deployed when any changes pushed to
>> > master
>> > > > branch, and all generated files are under the ASF branch, not sure
>> if
>> > we
>> > > > could trigger the docs only deployment.
>> > > >
>> > > > We may get some suggestions from Ming :)
>> > > >
>> > > > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五上午3:06写道:
>> > > >
>> > > > > Hello All,
>> > > > >
>> > > > > The docs of APISIX has been recently refactored to autogenerate
>> > > > > <https://docsify.js.org/#/> a webpage by parsing the APISIX
>> markdown
>> > > > > files.
>> > > > >
>> > > > > The following URL shows how it will look like:
>> > > > > - https://sshniro.github.io/apisix-docsify/#/
>> > > > >
>> > > > > In order make this useful for the community can we host this under
>> > the
>> > > > > APISIX website domain? The deployment should be fairly simple by
>> > > > deploying
>> > > > > the contents of the doc folder to the server and does not involve
>> any
>> > > > > compilation steps.
>> > > > >
>> > > > > Furthermore, can we also setup GitHub actions to auto-deploy the
>> site
>> > > > after
>> > > > > any changes to the docs?
>> > > > >
>> > > > > --
>> > > > > Best Regards,
>> > > > > S.Nirojan
>> > > > > Linked-in <https://www.linkedin.com/in/niroselva/>
>> > > > >
>> > > > --
>> > > > 来自 琚致远
>> > > >
>> > >
>> > >
>> > > --
>> > > Best Regards,
>> > > S.Nirojan
>> > > Linked-in <https://www.linkedin.com/in/niroselva/>
>> > >
>> > --
>> > 来自 琚致远
>> >
>>
>>
>> --
>> Best Regards,
>> S.Nirojan
>> Linked-in <https://www.linkedin.com/in/niroselva/>
>>
> --
> 来自 琚致远
>
-- 
来自 琚致远

Re: [Discuss] Host APISIX docs generated by Docsify

Posted by Zhiyuan Ju <ju...@apache.org>.
OK!

Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五下午9:07写道:

> Thank you for the suggestions, Yes, I will target with deploying the last
> released version of APISIX.
>
> @Zhiyuan: Sure, I will try to integrate with Hugo first and will get back
> to you if I face any problems.
>
> On Fri, Jul 17, 2020 at 12:52 PM Zhiyuan Ju <ju...@apache.org> wrote:
>
> > If it’s difficult to connect Docsify with Hugo, we may consider
> refactoring
> > the website with new architecture, use Vue.js for both website and docs
> for
> > example.
> >
> > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五下午2:52写道:
> >
> > > Hi Zhiyuan,
> > >
> > > Thank you for the information. I will try to modify the website
> > repository
> > > to include the docs folder when deploying the site to GitHub pages.
> > > I assume a corn job-based deployment would resolve the continuous
> > > deployment problem for now I presume?
> > >
> > > On Thu, Jul 16, 2020 at 11:02 PM Zhiyuan Ju <ju...@apache.org>
> > wrote:
> > >
> > > > Hi, sshniro,
> > > >
> > > > It’s a nice document site for me.
> > > >
> > > > The apisix.apache.org is auto deployed when any changes pushed to
> > master
> > > > branch, and all generated files are under the ASF branch, not sure if
> > we
> > > > could trigger the docs only deployment.
> > > >
> > > > We may get some suggestions from Ming :)
> > > >
> > > > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五上午3:06写道:
> > > >
> > > > > Hello All,
> > > > >
> > > > > The docs of APISIX has been recently refactored to autogenerate
> > > > > <https://docsify.js.org/#/> a webpage by parsing the APISIX
> markdown
> > > > > files.
> > > > >
> > > > > The following URL shows how it will look like:
> > > > > - https://sshniro.github.io/apisix-docsify/#/
> > > > >
> > > > > In order make this useful for the community can we host this under
> > the
> > > > > APISIX website domain? The deployment should be fairly simple by
> > > > deploying
> > > > > the contents of the doc folder to the server and does not involve
> any
> > > > > compilation steps.
> > > > >
> > > > > Furthermore, can we also setup GitHub actions to auto-deploy the
> site
> > > > after
> > > > > any changes to the docs?
> > > > >
> > > > > --
> > > > > Best Regards,
> > > > > S.Nirojan
> > > > > Linked-in <https://www.linkedin.com/in/niroselva/>
> > > > >
> > > > --
> > > > 来自 琚致远
> > > >
> > >
> > >
> > > --
> > > Best Regards,
> > > S.Nirojan
> > > Linked-in <https://www.linkedin.com/in/niroselva/>
> > >
> > --
> > 来自 琚致远
> >
>
>
> --
> Best Regards,
> S.Nirojan
> Linked-in <https://www.linkedin.com/in/niroselva/>
>
-- 
来自 琚致远

Re: [Discuss] Host APISIX docs generated by Docsify

Posted by Nirojan Selvanathan <ss...@gmail.com>.
Thank you for the suggestions, Yes, I will target with deploying the last
released version of APISIX.

@Zhiyuan: Sure, I will try to integrate with Hugo first and will get back
to you if I face any problems.

On Fri, Jul 17, 2020 at 12:52 PM Zhiyuan Ju <ju...@apache.org> wrote:

> If it’s difficult to connect Docsify with Hugo, we may consider refactoring
> the website with new architecture, use Vue.js for both website and docs for
> example.
>
> Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五下午2:52写道:
>
> > Hi Zhiyuan,
> >
> > Thank you for the information. I will try to modify the website
> repository
> > to include the docs folder when deploying the site to GitHub pages.
> > I assume a corn job-based deployment would resolve the continuous
> > deployment problem for now I presume?
> >
> > On Thu, Jul 16, 2020 at 11:02 PM Zhiyuan Ju <ju...@apache.org>
> wrote:
> >
> > > Hi, sshniro,
> > >
> > > It’s a nice document site for me.
> > >
> > > The apisix.apache.org is auto deployed when any changes pushed to
> master
> > > branch, and all generated files are under the ASF branch, not sure if
> we
> > > could trigger the docs only deployment.
> > >
> > > We may get some suggestions from Ming :)
> > >
> > > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五上午3:06写道:
> > >
> > > > Hello All,
> > > >
> > > > The docs of APISIX has been recently refactored to autogenerate
> > > > <https://docsify.js.org/#/> a webpage by parsing the APISIX markdown
> > > > files.
> > > >
> > > > The following URL shows how it will look like:
> > > > - https://sshniro.github.io/apisix-docsify/#/
> > > >
> > > > In order make this useful for the community can we host this under
> the
> > > > APISIX website domain? The deployment should be fairly simple by
> > > deploying
> > > > the contents of the doc folder to the server and does not involve any
> > > > compilation steps.
> > > >
> > > > Furthermore, can we also setup GitHub actions to auto-deploy the site
> > > after
> > > > any changes to the docs?
> > > >
> > > > --
> > > > Best Regards,
> > > > S.Nirojan
> > > > Linked-in <https://www.linkedin.com/in/niroselva/>
> > > >
> > > --
> > > 来自 琚致远
> > >
> >
> >
> > --
> > Best Regards,
> > S.Nirojan
> > Linked-in <https://www.linkedin.com/in/niroselva/>
> >
> --
> 来自 琚致远
>


-- 
Best Regards,
S.Nirojan
Linked-in <https://www.linkedin.com/in/niroselva/>

Re: [Discuss] Host APISIX docs generated by Docsify

Posted by Zhiyuan Ju <ju...@apache.org>.
If it’s difficult to connect Docsify with Hugo, we may consider refactoring
the website with new architecture, use Vue.js for both website and docs for
example.

Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五下午2:52写道:

> Hi Zhiyuan,
>
> Thank you for the information. I will try to modify the website repository
> to include the docs folder when deploying the site to GitHub pages.
> I assume a corn job-based deployment would resolve the continuous
> deployment problem for now I presume?
>
> On Thu, Jul 16, 2020 at 11:02 PM Zhiyuan Ju <ju...@apache.org> wrote:
>
> > Hi, sshniro,
> >
> > It’s a nice document site for me.
> >
> > The apisix.apache.org is auto deployed when any changes pushed to master
> > branch, and all generated files are under the ASF branch, not sure if we
> > could trigger the docs only deployment.
> >
> > We may get some suggestions from Ming :)
> >
> > Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五上午3:06写道:
> >
> > > Hello All,
> > >
> > > The docs of APISIX has been recently refactored to autogenerate
> > > <https://docsify.js.org/#/> a webpage by parsing the APISIX markdown
> > > files.
> > >
> > > The following URL shows how it will look like:
> > > - https://sshniro.github.io/apisix-docsify/#/
> > >
> > > In order make this useful for the community can we host this under the
> > > APISIX website domain? The deployment should be fairly simple by
> > deploying
> > > the contents of the doc folder to the server and does not involve any
> > > compilation steps.
> > >
> > > Furthermore, can we also setup GitHub actions to auto-deploy the site
> > after
> > > any changes to the docs?
> > >
> > > --
> > > Best Regards,
> > > S.Nirojan
> > > Linked-in <https://www.linkedin.com/in/niroselva/>
> > >
> > --
> > 来自 琚致远
> >
>
>
> --
> Best Regards,
> S.Nirojan
> Linked-in <https://www.linkedin.com/in/niroselva/>
>
-- 
来自 琚致远

Re: [Discuss] Host APISIX docs generated by Docsify

Posted by Nirojan Selvanathan <ss...@gmail.com>.
Hi Zhiyuan,

Thank you for the information. I will try to modify the website repository
to include the docs folder when deploying the site to GitHub pages.
I assume a corn job-based deployment would resolve the continuous
deployment problem for now I presume?

On Thu, Jul 16, 2020 at 11:02 PM Zhiyuan Ju <ju...@apache.org> wrote:

> Hi, sshniro,
>
> It’s a nice document site for me.
>
> The apisix.apache.org is auto deployed when any changes pushed to master
> branch, and all generated files are under the ASF branch, not sure if we
> could trigger the docs only deployment.
>
> We may get some suggestions from Ming :)
>
> Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五上午3:06写道:
>
> > Hello All,
> >
> > The docs of APISIX has been recently refactored to autogenerate
> > <https://docsify.js.org/#/> a webpage by parsing the APISIX markdown
> > files.
> >
> > The following URL shows how it will look like:
> > - https://sshniro.github.io/apisix-docsify/#/
> >
> > In order make this useful for the community can we host this under the
> > APISIX website domain? The deployment should be fairly simple by
> deploying
> > the contents of the doc folder to the server and does not involve any
> > compilation steps.
> >
> > Furthermore, can we also setup GitHub actions to auto-deploy the site
> after
> > any changes to the docs?
> >
> > --
> > Best Regards,
> > S.Nirojan
> > Linked-in <https://www.linkedin.com/in/niroselva/>
> >
> --
> 来自 琚致远
>


-- 
Best Regards,
S.Nirojan
Linked-in <https://www.linkedin.com/in/niroselva/>

Re: [Discuss] Host APISIX docs generated by Docsify

Posted by Zhiyuan Ju <ju...@apache.org>.
Hi, sshniro,

It’s a nice document site for me.

The apisix.apache.org is auto deployed when any changes pushed to master
branch, and all generated files are under the ASF branch, not sure if we
could trigger the docs only deployment.

We may get some suggestions from Ming :)

Nirojan Selvanathan <ss...@gmail.com>于2020年7月17日 周五上午3:06写道:

> Hello All,
>
> The docs of APISIX has been recently refactored to autogenerate
> <https://docsify.js.org/#/> a webpage by parsing the APISIX markdown
> files.
>
> The following URL shows how it will look like:
> - https://sshniro.github.io/apisix-docsify/#/
>
> In order make this useful for the community can we host this under the
> APISIX website domain? The deployment should be fairly simple by deploying
> the contents of the doc folder to the server and does not involve any
> compilation steps.
>
> Furthermore, can we also setup GitHub actions to auto-deploy the site after
> any changes to the docs?
>
> --
> Best Regards,
> S.Nirojan
> Linked-in <https://www.linkedin.com/in/niroselva/>
>
-- 
来自 琚致远