You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@apisix.apache.org by Zhiyuan Ju <ju...@apache.org> on 2020/10/13 11:41:17 UTC

[DISCUSS] Migrating docs from apisix's repo to website's repo

Hi, folks,

Could we migrate all docs from apisix's repository to website's
repository[1]? It would be more friendly for developers to learn and
search, see this site[2] for detail.

Any ideas?

[1] https://github.com/apache/apisix-website/issues/78
[2] https://apisix.apache.org/docs/release-guide/

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

Re: [DISCUSS] Migrating docs from apisix's repo to website's repo

Posted by Zhiyuan Ju <ju...@apache.org>.
Looks good to me in this way, let me check this.

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


Shuyang Wu <sh...@apache.org> 于2020年10月13日周二 下午11:13写道：

> I'm not very familiar with the front-end. As far as I know, chaos mesh
> <https://github.com/chaos-mesh/chaos-mesh.github.io> is using netlify to
> build the website out of two repos - the main one and the website one. Each
> time doc is changed in the main repo, the website repo would auto-sync the
> change and re-deploy the website. See the guidance
> <
> https://community.netlify.com/t/support-guide-can-i-deploy-multiple-repositories-in-a-single-site/179
> >.
> Also netlify provide github actions so we could check the change for each
> commit.
> >
> >
> It just would be a pain to refactor the website, especially when we just
> change it to docusaurus at the end of August.
>
> YuanSheng Wang <me...@apache.org> 于2020年10月13日周二 下午9:56写道：
>
> > the `markdown` doc in Apache APISIX is the source file, keep the current
> > way.
> >
> > the website can sync the doc from the Apache APISIX project when it has
> any
> > update.
> > And compile these documents into the required format.
> >
> >
> > On Tue, Oct 13, 2020 at 7:41 PM Zhiyuan Ju <ju...@apache.org> wrote:
> >
> > > Hi, folks,
> > >
> > > Could we migrate all docs from apisix's repository to website's
> > > repository[1]? It would be more friendly for developers to learn and
> > > search, see this site[2] for detail.
> > >
> > > Any ideas?
> > >
> > > [1] https://github.com/apache/apisix-website/issues/78
> > > [2] https://apisix.apache.org/docs/release-guide/
> > >
> > > Best Regards!
> > > @ Zhiyuan Ju <https://www.shaoyaoju.org/>
> > >
> >
> >
> > --
> >
> > *MembPhis*
> > My GitHub: https://github.com/membphis
> > Apache APISIX: https://github.com/apache/apisix
> >
>

Re: [DISCUSS] Migrating docs from apisix's repo to website's repo

Posted by Shuyang Wu <sh...@apache.org>.
I'm not very familiar with the front-end. As far as I know, chaos mesh
<https://github.com/chaos-mesh/chaos-mesh.github.io> is using netlify to
build the website out of two repos - the main one and the website one. Each
time doc is changed in the main repo, the website repo would auto-sync the
change and re-deploy the website. See the guidance
<https://community.netlify.com/t/support-guide-can-i-deploy-multiple-repositories-in-a-single-site/179>.
Also netlify provide github actions so we could check the change for each
commit.
>
>
It just would be a pain to refactor the website, especially when we just
change it to docusaurus at the end of August.

YuanSheng Wang <me...@apache.org> 于2020年10月13日周二 下午9:56写道：

> the `markdown` doc in Apache APISIX is the source file, keep the current
> way.
>
> the website can sync the doc from the Apache APISIX project when it has any
> update.
> And compile these documents into the required format.
>
>
> On Tue, Oct 13, 2020 at 7:41 PM Zhiyuan Ju <ju...@apache.org> wrote:
>
> > Hi, folks,
> >
> > Could we migrate all docs from apisix's repository to website's
> > repository[1]? It would be more friendly for developers to learn and
> > search, see this site[2] for detail.
> >
> > Any ideas?
> >
> > [1] https://github.com/apache/apisix-website/issues/78
> > [2] https://apisix.apache.org/docs/release-guide/
> >
> > Best Regards!
> > @ Zhiyuan Ju <https://www.shaoyaoju.org/>
> >
>
>
> --
>
> *MembPhis*
> My GitHub: https://github.com/membphis
> Apache APISIX: https://github.com/apache/apisix
>

Re: [DISCUSS] Migrating docs from apisix's repo to website's repo

Posted by YuanSheng Wang <me...@apache.org>.
the `markdown` doc in Apache APISIX is the source file, keep the current
way.

the website can sync the doc from the Apache APISIX project when it has any
update.
And compile these documents into the required format.


On Tue, Oct 13, 2020 at 7:41 PM Zhiyuan Ju <ju...@apache.org> wrote:

> Hi, folks,
>
> Could we migrate all docs from apisix's repository to website's
> repository[1]? It would be more friendly for developers to learn and
> search, see this site[2] for detail.
>
> Any ideas?
>
> [1] https://github.com/apache/apisix-website/issues/78
> [2] https://apisix.apache.org/docs/release-guide/
>
> Best Regards!
> @ Zhiyuan Ju <https://www.shaoyaoju.org/>
>


-- 

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