Re: Auto-generating documentation site..
That’s my fault. I forgot to delete the docs directory after converting over to the asf-site branch. I will take care of this. -Taylor > On Nov 5, 2015, at 10:46 AM, Bobby Evanswrote: > > I followed my own comment to generate the site in the docs directory, and I > tried to copy it over to subversion, but didn't check it in because things > had changed. I didn't use the branch asf-site, I didn't know it was there > because we still have the docs directory with instructions on how to use it. > Having a separate branch in git for the site and still having the docs > directory is very confusing. We have had a few pull requests update docs > recently which is why I was updating the site. Are we planning on keeping > separate releases for the site from the code? I am fine with that but we > should remove the docs directory from all development branches then, and have > someone look at the recent changes and pull them in to asf-site. > > - Bobby > > > > On Thursday, November 5, 2015 8:54 AM, 임정택 wrote: > Kishor and Bobby, > Did you use the branch 'asf-site'? > I checked but nothing is changed in 'asf-site' branch. > > Kishor, > Maybe Bobby's explanation for me could help you too, since seems like git > based publishing is not enabled yet. > https://github.com/apache/storm/pull/771#issuecomment-144726893 > > Best, > Jungtaek Lim (HeartSaVioR) > > > > > 2015-11-05 3:20 GMT+09:00 Bobby Evans : > >> I just tried to update it and the source under docs using the version of >> jekyll I have installed (2.5.2) is generating something that looks totally >> different from what we have on http://storm.apache.org/ Are there new >> instructions or a new version required for this? - Bobby >> >> >> On Wednesday, November 4, 2015 11:35 AM, Kishorkumar Patil >> wrote: >> >> >> Hello Taylor, >> I have pushed some more updates to the documentation in the git. But I am >> not sure how to update Storm Documentation site. >> >> Can you point me to steps on how to update this. Also, I am wondering if >> we have any planned/in progress(JIRA) automation to generate and publish >> this documentation? >> >> Regards,Kishor >> >> >> > > > > -- > Name : 임 정택 > Blog : http://www.heartsavior.net / http://dev.heartsavior.net > Twitter : http://twitter.com/heartsavior > LinkedIn : http://www.linkedin.com/in/heartsavior signature.asc Description: Message signed with OpenPGP using GPGMail
Re: Auto-generating documentation site..
Kishor, I also like the idea of having at least some of the docs with the code. Perhaps we could file a JIRA to reorganize the web-site so that some of the docs, not the general ones, but the ones that deal with APIs, etc are with the code and when we do a release a snapshot of it? I keep running into places where I have to put in the docs that this feature is available as of release X.Y.Z. I think it would be a lot better to just have some of the docs, per release. - Bobby On Thursday, November 5, 2015 10:39 AM, Kishorkumar Patilwrote: Thanks HeartSaVioR, Taylor, I would have preferred code and documentation be on the same branch - specially considering documentation and generated JavaDocs. Secondly, it would be ideal to have same branch generate docs by release version and one pointing to the current version tagged by version. I don't fully understand the reasons for separating docs from code. Is there as reason we want to make it separate? -Kishor On Thursday, November 5, 2015 10:32 AM, P. Taylor Goetz wrote: That’s my fault. I forgot to delete the docs directory after converting over to the asf-site branch. I will take care of this. -Taylor > On Nov 5, 2015, at 10:46 AM, Bobby Evans wrote: > > I followed my own comment to generate the site in the docs directory, and I > tried to copy it over to subversion, but didn't check it in because things > had changed. I didn't use the branch asf-site, I didn't know it was there > because we still have the docs directory with instructions on how to use it. > Having a separate branch in git for the site and still having the docs > directory is very confusing. We have had a few pull requests update docs > recently which is why I was updating the site. Are we planning on keeping > separate releases for the site from the code? I am fine with that but we > should remove the docs directory from all development branches then, and have > someone look at the recent changes and pull them in to asf-site. > > - Bobby > > > > On Thursday, November 5, 2015 8:54 AM, 임정택 wrote: > Kishor and Bobby, > Did you use the branch 'asf-site'? > I checked but nothing is changed in 'asf-site' branch. > > Kishor, > Maybe Bobby's explanation for me could help you too, since seems like git > based publishing is not enabled yet. > https://github.com/apache/storm/pull/771#issuecomment-144726893 > > Best, > Jungtaek Lim (HeartSaVioR) > > > > > 2015-11-05 3:20 GMT+09:00 Bobby Evans : > >> I just tried to update it and the source under docs using the version of >> jekyll I have installed (2.5.2) is generating something that looks totally >> different from what we have on http://storm.apache.org/ Are there new >> instructions or a new version required for this? - Bobby >> >> >>On Wednesday, November 4, 2015 11:35 AM, Kishorkumar Patil >> wrote: >> >> >> Hello Taylor, >> I have pushed some more updates to the documentation in the git. But I am >> not sure how to update Storm Documentation site. >> >> Can you point me to steps on how to update this. Also, I am wondering if >> we have any planned/in progress(JIRA) automation to generate and publish >> this documentation? >> >> Regards,Kishor >> >> >> > > > > -- > Name : 임 정택 > Blog : http://www.heartsavior.net / http://dev.heartsavior.net > Twitter : http://twitter.com/heartsavior > LinkedIn : http://www.linkedin.com/in/heartsavior
Re: Auto-generating documentation site..
Thanks HeartSaVioR, Taylor, I would have preferred code and documentation be on the same branch - specially considering documentation and generated JavaDocs. Secondly, it would be ideal to have same branch generate docs by release version and one pointing to the current version tagged by version. I don't fully understand the reasons for separating docs from code. Is there as reason we want to make it separate? -Kishor On Thursday, November 5, 2015 10:32 AM, P. Taylor Goetzwrote: That’s my fault. I forgot to delete the docs directory after converting over to the asf-site branch. I will take care of this. -Taylor > On Nov 5, 2015, at 10:46 AM, Bobby Evans wrote: > > I followed my own comment to generate the site in the docs directory, and I > tried to copy it over to subversion, but didn't check it in because things > had changed. I didn't use the branch asf-site, I didn't know it was there > because we still have the docs directory with instructions on how to use it. > Having a separate branch in git for the site and still having the docs > directory is very confusing. We have had a few pull requests update docs > recently which is why I was updating the site. Are we planning on keeping > separate releases for the site from the code? I am fine with that but we > should remove the docs directory from all development branches then, and have > someone look at the recent changes and pull them in to asf-site. > > - Bobby > > > > On Thursday, November 5, 2015 8:54 AM, 임정택 wrote: > Kishor and Bobby, > Did you use the branch 'asf-site'? > I checked but nothing is changed in 'asf-site' branch. > > Kishor, > Maybe Bobby's explanation for me could help you too, since seems like git > based publishing is not enabled yet. > https://github.com/apache/storm/pull/771#issuecomment-144726893 > > Best, > Jungtaek Lim (HeartSaVioR) > > > > > 2015-11-05 3:20 GMT+09:00 Bobby Evans : > >> I just tried to update it and the source under docs using the version of >> jekyll I have installed (2.5.2) is generating something that looks totally >> different from what we have on http://storm.apache.org/ Are there new >> instructions or a new version required for this? - Bobby >> >> >> On Wednesday, November 4, 2015 11:35 AM, Kishorkumar Patil >> wrote: >> >> >> Hello Taylor, >> I have pushed some more updates to the documentation in the git. But I am >> not sure how to update Storm Documentation site. >> >> Can you point me to steps on how to update this. Also, I am wondering if >> we have any planned/in progress(JIRA) automation to generate and publish >> this documentation? >> >> Regards,Kishor >> >> >> > > > > -- > Name : 임 정택 > Blog : http://www.heartsavior.net / http://dev.heartsavior.net > Twitter : http://twitter.com/heartsavior > LinkedIn : http://www.linkedin.com/in/heartsavior
Re: Auto-generating documentation site..
Taylor before you delete the docs directory, please check the changelog to see what has been modified and make sure we pull them into the new branch? - Bobby On Thursday, November 5, 2015 10:32 AM, P. Taylor Goetzwrote: That’s my fault. I forgot to delete the docs directory after converting over to the asf-site branch. I will take care of this. -Taylor > On Nov 5, 2015, at 10:46 AM, Bobby Evans wrote: > > I followed my own comment to generate the site in the docs directory, and I > tried to copy it over to subversion, but didn't check it in because things > had changed. I didn't use the branch asf-site, I didn't know it was there > because we still have the docs directory with instructions on how to use it. > Having a separate branch in git for the site and still having the docs > directory is very confusing. We have had a few pull requests update docs > recently which is why I was updating the site. Are we planning on keeping > separate releases for the site from the code? I am fine with that but we > should remove the docs directory from all development branches then, and have > someone look at the recent changes and pull them in to asf-site. > > - Bobby > > > > On Thursday, November 5, 2015 8:54 AM, 임정택 wrote: > Kishor and Bobby, > Did you use the branch 'asf-site'? > I checked but nothing is changed in 'asf-site' branch. > > Kishor, > Maybe Bobby's explanation for me could help you too, since seems like git > based publishing is not enabled yet. > https://github.com/apache/storm/pull/771#issuecomment-144726893 > > Best, > Jungtaek Lim (HeartSaVioR) > > > > > 2015-11-05 3:20 GMT+09:00 Bobby Evans : > >> I just tried to update it and the source under docs using the version of >> jekyll I have installed (2.5.2) is generating something that looks totally >> different from what we have on http://storm.apache.org/ Are there new >> instructions or a new version required for this? - Bobby >> >> >> On Wednesday, November 4, 2015 11:35 AM, Kishorkumar Patil >> wrote: >> >> >> Hello Taylor, >> I have pushed some more updates to the documentation in the git. But I am >> not sure how to update Storm Documentation site. >> >> Can you point me to steps on how to update this. Also, I am wondering if >> we have any planned/in progress(JIRA) automation to generate and publish >> this documentation? >> >> Regards,Kishor >> >> >> > > > > -- > Name : 임 정택 > Blog : http://www.heartsavior.net / http://dev.heartsavior.net > Twitter : http://twitter.com/heartsavior > LinkedIn : http://www.linkedin.com/in/heartsavior
Re: Auto-generating documentation site..
Absolutely. That was the plan. -Taylor > On Nov 5, 2015, at 12:25 PM, Bobby Evanswrote: > > Taylor before you delete the docs directory, please check the changelog to > see what has been modified and make sure we pull them into the new branch? > > > - Bobby > > > > On Thursday, November 5, 2015 10:32 AM, P. Taylor Goetz > wrote: > That’s my fault. I forgot to delete the docs directory after converting over > to the asf-site branch. > > I will take care of this. > > -Taylor > > >> On Nov 5, 2015, at 10:46 AM, Bobby Evans wrote: >> >> I followed my own comment to generate the site in the docs directory, and I >> tried to copy it over to subversion, but didn't check it in because things >> had changed. I didn't use the branch asf-site, I didn't know it was there >> because we still have the docs directory with instructions on how to use it. >> Having a separate branch in git for the site and still having the docs >> directory is very confusing. We have had a few pull requests update docs >> recently which is why I was updating the site. Are we planning on keeping >> separate releases for the site from the code? I am fine with that but we >> should remove the docs directory from all development branches then, and >> have someone look at the recent changes and pull them in to asf-site. >> >> - Bobby >> >> >> >> On Thursday, November 5, 2015 8:54 AM, 임정택 wrote: >> Kishor and Bobby, >> Did you use the branch 'asf-site'? >> I checked but nothing is changed in 'asf-site' branch. >> >> Kishor, >> Maybe Bobby's explanation for me could help you too, since seems like git >> based publishing is not enabled yet. >> https://github.com/apache/storm/pull/771#issuecomment-144726893 >> >> Best, >> Jungtaek Lim (HeartSaVioR) >> >> >> >> >> 2015-11-05 3:20 GMT+09:00 Bobby Evans : >> >>> I just tried to update it and the source under docs using the version of >>> jekyll I have installed (2.5.2) is generating something that looks totally >>> different from what we have on http://storm.apache.org/ Are there new >>> instructions or a new version required for this? - Bobby >>> >>> >>>On Wednesday, November 4, 2015 11:35 AM, Kishorkumar Patil >>> wrote: >>> >>> >>> Hello Taylor, >>> I have pushed some more updates to the documentation in the git. But I am >>> not sure how to update Storm Documentation site. >>> >>> Can you point me to steps on how to update this. Also, I am wondering if >>> we have any planned/in progress(JIRA) automation to generate and publish >>> this documentation? >>> >>> Regards,Kishor >>> >>> >>> >> >> >> >> -- >> Name : 임 정택 >> Blog : http://www.heartsavior.net / http://dev.heartsavior.net >> Twitter : http://twitter.com/heartsavior >> LinkedIn : http://www.linkedin.com/in/heartsavior signature.asc Description: Message signed with OpenPGP using GPGMail
Re: Auto-generating documentation site..
I followed my own comment to generate the site in the docs directory, and I tried to copy it over to subversion, but didn't check it in because things had changed. I didn't use the branch asf-site, I didn't know it was there because we still have the docs directory with instructions on how to use it. Having a separate branch in git for the site and still having the docs directory is very confusing. We have had a few pull requests update docs recently which is why I was updating the site. Are we planning on keeping separate releases for the site from the code? I am fine with that but we should remove the docs directory from all development branches then, and have someone look at the recent changes and pull them in to asf-site. - Bobby On Thursday, November 5, 2015 8:54 AM, 임정택wrote: Kishor and Bobby, Did you use the branch 'asf-site'? I checked but nothing is changed in 'asf-site' branch. Kishor, Maybe Bobby's explanation for me could help you too, since seems like git based publishing is not enabled yet. https://github.com/apache/storm/pull/771#issuecomment-144726893 Best, Jungtaek Lim (HeartSaVioR) 2015-11-05 3:20 GMT+09:00 Bobby Evans : > I just tried to update it and the source under docs using the version of > jekyll I have installed (2.5.2) is generating something that looks totally > different from what we have on http://storm.apache.org/ Are there new > instructions or a new version required for this? - Bobby > > > On Wednesday, November 4, 2015 11:35 AM, Kishorkumar Patil > wrote: > > > Hello Taylor, > I have pushed some more updates to the documentation in the git. But I am > not sure how to update Storm Documentation site. > > Can you point me to steps on how to update this. Also, I am wondering if > we have any planned/in progress(JIRA) automation to generate and publish > this documentation? > > Regards,Kishor > > > -- Name : 임 정택 Blog : http://www.heartsavior.net / http://dev.heartsavior.net Twitter : http://twitter.com/heartsavior LinkedIn : http://www.linkedin.com/in/heartsavior
Re: Auto-generating documentation site..
Kishor and Bobby, Did you use the branch 'asf-site'? I checked but nothing is changed in 'asf-site' branch. Kishor, Maybe Bobby's explanation for me could help you too, since seems like git based publishing is not enabled yet. https://github.com/apache/storm/pull/771#issuecomment-144726893 Best, Jungtaek Lim (HeartSaVioR) 2015-11-05 3:20 GMT+09:00 Bobby Evans: > I just tried to update it and the source under docs using the version of > jekyll I have installed (2.5.2) is generating something that looks totally > different from what we have on http://storm.apache.org/ Are there new > instructions or a new version required for this? - Bobby > > > On Wednesday, November 4, 2015 11:35 AM, Kishorkumar Patil > wrote: > > > Hello Taylor, > I have pushed some more updates to the documentation in the git. But I am > not sure how to update Storm Documentation site. > > Can you point me to steps on how to update this. Also, I am wondering if > we have any planned/in progress(JIRA) automation to generate and publish > this documentation? > > Regards,Kishor > > > -- Name : 임 정택 Blog : http://www.heartsavior.net / http://dev.heartsavior.net Twitter : http://twitter.com/heartsavior LinkedIn : http://www.linkedin.com/in/heartsavior
Re: Auto-generating documentation site..
I just tried to update it and the source under docs using the version of jekyll I have installed (2.5.2) is generating something that looks totally different from what we have on http://storm.apache.org/ Are there new instructions or a new version required for this? - Bobby On Wednesday, November 4, 2015 11:35 AM, Kishorkumar Patilwrote: Hello Taylor, I have pushed some more updates to the documentation in the git. But I am not sure how to update Storm Documentation site. Can you point me to steps on how to update this. Also, I am wondering if we have any planned/in progress(JIRA) automation to generate and publish this documentation? Regards,Kishor