Some personal advice:
1. It’s recommended that each version be mapped to one document, because
it's easier for users to find out if an interface change is made to one version
than to confuse them.
2. The title dubbo-parent 2.7.2 API is recommended for Apache Dubbo 2.7.2
API or Dubbo Framework 2.7.2 API.
3. Can Deprecated interface be reflected in the screenshot below?
[X]
原始邮件
发件人: Huxing Zhang<hux...@apache.org>
收件人: dev<dev@dubbo.apache.org>
发送时间: 2019年6月17日(周一) 11:35
主题: Re: [DISCUSS] Branch strategy for dubbo-website
Hi,
On Mon, Jun 17, 2019 at 11:17 AM YunKun Huang
<hty...@gmail.com<mailto:hty...@gmail.com>> wrote:
>
> yeah. I mean dubbo 2.x.
>
> but I also have a look at tomcat api doc(
> https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftomcat.apache.org%2Ftomcat-8.5-doc%2Fapi%2F&data=02%7C01%7C%7Cdb327898309145ba5b4208d6f2d4f071%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636963393708870116&sdata=fAKRoMbrXGQoUMKuV7zYCc%2BivKQEYwppXXDWXazvpbk%3D&reserved=0)
> maybe we can follow similar way. for example, for version 2.7.x, we have
> 2.7.1 and 2.7.2, we only publish version 2.7.2 under dubbo-2.7-doc folder.
+1 to put the doc for latest stable version.
>
> On Mon, Jun 17, 2019 at 11:01 AM Huxing Zhang
> <hux...@apache.org<mailto:hux...@apache.org>> wrote:
>
> > Hi,
> >
> > On Sat, Jun 15, 2019 at 10:40 AM YunKun Huang
> > <hty...@gmail.com<mailto:hty...@gmail.com>> wrote:
> > >
> > > hey,
> > >
> > > The branch config change is done. And after two days testing for jenkins
> > > job, I turn off dryrun mode.
> > >
> > > Now all changes to dubbo-website will rebuild by CI, there may has some
> > > delay (changes may apply to website after a few hours.).
> > >
> > > If there is any change you want to made, please submit PR to master
> > branch.
> > > asf-site will handle by CI
> > >
> > > I also add a api-doc deployment job (
> > >
> > https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbuilds.apache.org%2Fjob%2FApache%2520Dubbo%2Fjob%2Fapache-dubbo-apidoc-deployment%2F&data=02%7C01%7C%7Cdb327898309145ba5b4208d6f2d4f071%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636963393708870116&sdata=nzKvmmE9xtJ1c9tsWXih1FHZYNIC%2BG9LwWwlXz885ek%3D&reserved=0
> > )
> > > which is required manual trigger with dubbo version param.
> > > Version 2.7.2 is ready at
> > > https://eur04.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdubbo.apache.org%2Fdubbo-2.0-doc%2Fapi%2F&data=02%7C01%7C%7Cdb327898309145ba5b4208d6f2d4f071%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636963393708870116&sdata=BibpTRoz%2BKAFXFclNW1b2sJ0MYDjZCPCQ5bTDr1r%2BH8%3D&reserved=0
> > now.
> >
> > Great work! I have a minor question:
> > Why the url is
> > https://eur04.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdubbo.apache.org%2Fdubbo-2.0-doc%2Fapi%2F&data=02%7C01%7C%7Cdb327898309145ba5b4208d6f2d4f071%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636963393708870116&sdata=BibpTRoz%2BKAFXFclNW1b2sJ0MYDjZCPCQ5bTDr1r%2BH8%3D&reserved=0?
> > If you mean dubbo 2.x, how about:
> > https://eur04.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdubbo.apache.org%2Fdubbo-2.x-doc%2Fapi%2F&data=02%7C01%7C%7Cdb327898309145ba5b4208d6f2d4f071%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636963393708870116&sdata=Jl0KlDxVpEYx5VeXaOZvKoWuybfQzsK7ihNfP0sK5KE%3D&reserved=0
> > ?
> > If you mean the latest stable version, how about
> > https://eur04.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdubbo.apache.org%2Fdubbo-2.7.2-doc%2Fapi%2F&data=02%7C01%7C%7Cdb327898309145ba5b4208d6f2d4f071%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636963393708870116&sdata=6b5dTi2bZrfyHddlimd9ru2zw4giUcY4QYfKeTLTxsM%3D&reserved=0
> > ?
> >
> > >
> > > On Thu, Jun 13, 2019 at 9:03 PM YunKun Huang
> > > <hyun...@apache.org<mailto:hyun...@apache.org>> wrote:
> > >
> > > > Now jenksin job is ready with dryrun mode:
> > > >
> > https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbuilds.apache.org%2Fjob%2FApache%2520Dubbo%2Fjob%2Fapache-dubbo-website-deployment%2F64%2Fconsole&data=02%7C01%7C%7Cdb327898309145ba5b4208d6f2d4f071%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636963393708870116&sdata=0TSRKFKtiYznsN0rah%2BImLK4DCurYF%2BANtfDFZ28Id0%3D&reserved=0
> > > >
> > > > I'm going to asking help from Infra team to setup master branch as
> > default
> > > > branch for dubbo-website.
> > > > Once branch configuration is done, I will enable jenkins job and turn
> > on
> > > > automatic build for dubbo website
> > > >
> > > > On 2019/06/13 03:09:30, Yuhao Bi
> > > > <byh0...@gmail.com<mailto:byh0...@gmail.com>> wrote:
> > > > > +1
> > > > > good idea
> > > > >
> > > > > Huxing Zhang <hux...@apache.org<mailto:hux...@apache.org>>
> > > > > 于2019年6月13日周四 上午10:26写道：
> > > > >
> > > > > > Hi,
> > > > > >
> > > > > > On Wed, Jun 12, 2019 at 10:36 PM YunKun Huang
> > > > > > <hty...@gmail.com<mailto:hty...@gmail.com>>
> > > > wrote:
> > > > > > >
> > > > > > > hey,
> > > > > > >
> > > > > > > I'm working on a jenkins job to automaticlly generate website and
> > > > push
> > > > > > back
> > > > > > > to git repo.
> > > > > > >
> > > > > > > When I working on it, I noticed the dubbo-website only has one
> > active
> > > > > > > branch named 'asf-site'.
> > > > > > >
> > > > > > > The website is managed by a tool named 'docsite' which can
> > generate
> > > > > > website
> > > > > > > from source files.
> > > > > > > Currently for dubbo-website, all source files and generated files
> > > > are in
> > > > > > > same branch. it will cause some issue:
> > > > > > >
> > > > > > > 1.for user who want to contribute to website, he/she need clone
> > > > generated
> > > > > > > files togethere which is not nessary
> > > > > > > 2.people will confuse for which one need change, people may
> > create
> > > > PR to
> > > > > > > modify html which is generated and may overwite by docsite tool.
> > > > > > > 3.if we apply jenksin job to update website, the commit logs will
> > > > combine
> > > > > > > by jenkins automatic commit and other commits which is hard to
> > > > maintain.
> > > > > > >
> > > > > > > What i suggest is to use master branch to manage source files
> > which
> > > > > > accept
> > > > > > > PR and for asf-site branch, this is maintain by jenkins job.
> > > > > >
> > > > > > +1 to the proposal.
> > > > > >
> > > > > > >
> > > > > > > Camel website is using this strategy and looks like it works
> > well (
> > > > > > > https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fapache%2Fcamel-website&data=02%7C01%7C%7Cdb327898309145ba5b4208d6f2d4f071%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636963393708870116&sdata=Po17%2BBGwetdo333LKYEN0vRZURGczGc5ssnxpo%2BFQCc%3D&reserved=0)
> > > > > >
> > > > > >
> > > > > >
> > > > > > --
> > > > > > Best Regards！
> > > > > > Huxing
> > > > > >
> > > > >
> > > >
> >
> >
> >
> > --
> > Best Regards！
> > Huxing
> >
--
Best Regards！
Huxing
