You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@reef.apache.org by Byung-Gon Chun <bg...@gmail.com> on 2015/01/06 04:27:48 UTC
reef.incubator.apache.org is up and running!
Hi all,
http://reef.incubator.apache.org is up and running!
Many thanks to Josh, John, Jason, and Yunseong to make this happen!
You can update the page by making changes in
https://svn.apache.org/repos/asf/incubator/reef/site/
Cheers,
-Gon
--
Byung-Gon Chun
Re: reef.incubator.apache.org is up and running!
Posted by John Yang <jo...@gmail.com>.
Hi all,
I'll add a how-to article under the "Committer Guide" section(
https://cwiki.apache.org/confluence/display/REEF/Committer+Guide) on
editing the website by next week.
Thanks,
John
On Tue, Jan 6, 2015 at 12:27 PM, Byung-Gon Chun <bg...@gmail.com> wrote:
> Hi all,
>
> http://reef.incubator.apache.org is up and running!
>
> Many thanks to Josh, John, Jason, and Yunseong to make this happen!
>
> You can update the page by making changes in
> https://svn.apache.org/repos/asf/incubator/reef/site/
>
> Cheers,
> -Gon
>
> --
> Byung-Gon Chun
>
Re: reef.incubator.apache.org is up and running!
Posted by John Yang <jo...@gmail.com>.
Sure, I'll work with them and also with Yunseong and Josh.
We need to first merge Josh's branch into master though. Once that's done,
I'll go ahead and migrate the code to REEF repository.
John
On Fri, Jan 16, 2015 at 2:36 PM, Byung-Gon Chun <bg...@gmail.com> wrote:
> Moving the sources to our git sounds good. Is this something easily doable,
> John? I know you're busy with other tasks. I want you to work with Jason,
> Gyewon, and Woo-Yeon.
>
> Jason, Gyewon, and Woo-Yeon have been contributing to REEF. It would be
> great if we can add them to committers at some point.
>
> On Fri, Jan 16, 2015 at 1:52 PM, Markus Weimer <ma...@weimo.de> wrote:
>
> > Hi,
> >
> > I think the website sources need to be hosted on Apache infrastructure
> > in a way that grants all committers write access. Otherwise, we set
> > ourselves up with a continuous management chore.
> >
> > Hence, I am in favor of moving the sources to our git repository, if we
> > can get a script to do the update of the site set up. Also, just
> > managing the site via SVN seems like an ok path as well. We can still
> > use JIRA to discuss and approve patches.
> >
> > Markus
> >
> >
> > On 2015-01-15 17:53, Byung-Gon Chun wrote:
> > > Thanks, John.
> > >
> > > Note that https://github.com/cmssnu/websiteREEF will be moved to a
> > public
> > > one not under cmssnu if we take this path.
> > >
> > > All, what do you think about Jason's proposal?
> > >
> > > On Fri, Jan 16, 2015 at 10:46 AM, John Yang <jo...@gmail.com>
> wrote:
> > >
> > >> Hi Professor Chun,
> > >>
> > >>
> > >> sure, currently the code for the website(
> > http://reef.incubator.apache.org/
> > >> )
> > >> is being maintained at a private github repository.
> > >>
> > >> To use Apache infrastructure for hosting the site, we're using
> svnpubsub
> > >> which automatically checks out updates from
> > >> https://svn.apache.org/repos/asf/incubator/reef/ to where the
> contents
> > can
> > >> be published to http://reef.incubator.apache.org/.
> > >>
> > >> So while the code is being managed by git, the generated contents are
> > >> deployed by svn. I've written a wiki(access currently restricted to a
> > few
> > >> people, copy and pasted below) on how to manually bridge this gap, but
> > >> wanted to explore alternatives and Jason suggested one that I liked.
> > >>
> > >>
> > >> Thanks,
> > >> John
> > >>
> > >>
> > >>
> > >>
> > >> Contributing to REEF Website Development
> > >>
> > >> This article covers the process of contributing to the REEF website(
> > >> http://reef.incubator.apache.org/) development, from code/apidoc
> > editing
> > >> to
> > >> updating the running site.
> > >>
> > >>
> > >>
> > >> 1. Edit (The repo location should be changed)
> > >>
> > >> *Editing the code*
> > >>
> > >> The code for the website except the apidoc(
> > >> http://reef.incubator.apache.org/apidocs/index.html) is maintained
> at a
> > >> github repository(https://github.com/cmssnu/websiteREEF). Pull the
> code
> > >> from the repository, create a new branch, edit, and file a pull
> > request. An
> > >> example of a pull request is
> > https://github.com/cmssnu/websiteREEF/pull/1.
> > >> Editing the apidoc
> > >>
> > >> As the apidoc is generated from the source code of REEF first you
> should
> > >> make modifications in it and merge the changes into REEF master
> branch.
> > >> Once that's done, register an issue at
> > >> https://github.com/cmssnu/websiteREEF/issues to request for an apidoc
> > >> update, stating briefly of the changes.
> > >>
> > >>
> > >>
> > >> 2. Review
> > >>
> > >> Request code/apidoc review on the changes to a fellow committer and
> > resolve
> > >> all issues raised by her.
> > >>
> > >>
> > >>
> > >> 3. Update the Website locally (for the reviewers)
> > >>
> > >> First, svn checkout the existing version of the website using the
> > command:
> > >> $ svn checkout https://svn.apache.org/repos/asf/incubator/reef/
> > >>
> > >> This will create a directory named "reef". For convenience, we will
> > refer
> > >> to this directory as the svn repository from now on.
> > >> Updating static contents (except the apidoc)
> > >>
> > >> After all issues are resolved, merge the branch into master at
> > >> https://github.com/cmssnu/websiteREEF, download it and run the
> > following
> > >> command:
> > >> $ mvn clean site:site
> > >>
> > >> This will generate a directory named "target" and inside, there will
> be
> > a
> > >> directory named "site". The site folder contains all HTML files
> required
> > >> for the website and index.html is the default page shown when the
> > domain is
> > >> first accessed. Move(or copy) the contents into the corresponding
> > directory
> > >> in the svn repository and be mindful not to delete the
> > "reef/site/apidocs"
> > >> directory.
> > >> Updating apidoc
> > >>
> > >> After all issues are resolved, close the issue that requested the
> > update.
> > >> The, at $REEF_HOME run the following command.
> > >> $ mvn javadoc:aggregate
> > >>
> > >> This will create a directory named "apidocs" which includes all the
> > >> necessary Javadocs for REEF. Move(or copy) the files inside the
> > directory
> > >> into the "reef/site/apidocs" directory of the svn repository.
> > >>
> > >>
> > >>
> > >> 4. Update the running Website (for the reviewers)
> > >> Once 3. is done. You will have an updated version of the website on
> your
> > >> local computer. Re-check the changes using this command:
> > >> $ svn diff
> > >>
> > >>
> > >> To update the running website, at the svn repository, use the
> following
> > >> commands:
> > >> $ svn commit
> > >>
> > >> This will push the changes to
> > >> https://svn.apache.org/repos/asf/incubator/reef/, which will then be
> > >> automatically checked out by svnpubsub, as described in
> > >> https://www.apache.org/dev/project-site.html, and then to be
> published
> > at
> > >> http://reef.incubator.apache.org/.
> > >>
> > >>
> > >>
> > >> On Fri, Jan 16, 2015 at 10:37 AM, Byung-Gon Chun <bg...@gmail.com>
> > wrote:
> > >>
> > >>> John,
> > >>>
> > >>> Can you also share what the current set up is to give some contexts
> to
> > >>> members?
> > >>>
> > >>> Thanks.
> > >>> -Gon
> > >>>
> > >>> On Fri, Jan 16, 2015 at 10:24 AM, John Yang <jo...@gmail.com>
> > wrote:
> > >>>
> > >>>> Hi all,
> > >>>>
> > >>>>
> > >>>> I've had a discussion with Jason regarding the collaboration process
> > >> for
> > >>>> the website development. I've thought about several options such as
> > >> using
> > >>>> svn directly or using a separate github. But each has the tradeoff
> > >>> between
> > >>>> review convenience(github issues & PR) and deployment
> > >> convenience(manual
> > >>>> git-to-svn migration is painful).
> > >>>>
> > >>>>
> > >>>> Jason suggested:
> > >>>> "FYI, this is a link to Helix's Improve this Website page:
> > >>>> http://helix.apache.org/involved/contribdocs.html Their website
> > source
> > >>>> code
> > >>>> is simply included in their project source code, and thus can be
> > >> managed
> > >>>> with issues and PRs. They made a script (for committers) to automate
> > >> the
> > >>>> website publishing mechanism, too. This method could diminish "the
> > >>> overhead
> > >>>> of moving git-versioned files to svn" mentioned by John."
> > >>>> which I liked.
> > >>>>
> > >>>>
> > >>>> What are your thoughts?
> > >>>>
> > >>>>
> > >>>> John
> > >>>>
> > >>>>
> > >>>> On Fri, Jan 9, 2015 at 2:50 PM, Byung-Gon Chun <bg...@gmail.com>
> > >> wrote:
> > >>>>
> > >>>>> 1. Yes. This is common.
> > >>>>> 2. For contribution, we can create a link to it from the web site
> > >> since
> > >>>>> we've been effectively using cwiki instead of duplicating the
> > >> content.
> > >>>>>
> > >>>>> Thanks!
> > >>>>>
> > >>>>> On Fri, Jan 9, 2015 at 1:32 AM, Markus Weimer <ma...@weimo.de>
> > >> wrote:
> > >>>>>
> > >>>>>> Hi,
> > >>>>>>
> > >>>>>> I finally had the time to have a look. Great work, everyone! I
> > >> have a
> > >>>>>> few questions:
> > >>>>>>
> > >>>>>> 1. The list of people contains affiliations. Is that a common
> > >>> thing?
> > >>>>>> Apache projects are made up of the individuals, not
> > >>>>>> representatives of organizations, that is why I am asking
> > >>>>>> 2. Some of the content is taken from the wiki. Mostly the
> > >>> contributor
> > >>>>>> and related guides.We should decide where these live and
> > >> remove
> > >>>>>> the other copy. I am fine either way.
> > >>>>>>
> > >>>>>> Thanks,
> > >>>>>>
> > >>>>>> Markus
> > >>>>>>
> > >>>>>> On 2015-01-05 19:27, Byung-Gon Chun wrote:
> > >>>>>>> Hi all,
> > >>>>>>>
> > >>>>>>> http://reef.incubator.apache.org is up and running!
> > >>>>>>>
> > >>>>>>> Many thanks to Josh, John, Jason, and Yunseong to make this
> > >> happen!
> > >>>>>>>
> > >>>>>>> You can update the page by making changes in
> > >>>>>>> https://svn.apache.org/repos/asf/incubator/reef/site/
> > >>>>>>>
> > >>>>>>> Cheers,
> > >>>>>>> -Gon
> > >>>>>>>
> > >>>>>>
> > >>>>>
> > >>>>>
> > >>>>>
> > >>>>> --
> > >>>>> Byung-Gon Chun
> > >>>>>
> > >>>>
> > >>>
> > >>>
> > >>>
> > >>> --
> > >>> Byung-Gon Chun
> > >>>
> > >>
> > >
> > >
> > >
> >
>
>
>
> --
> Byung-Gon Chun
>
Re: reef.incubator.apache.org is up and running!
Posted by Byung-Gon Chun <bg...@gmail.com>.
Moving the sources to our git sounds good. Is this something easily doable,
John? I know you're busy with other tasks. I want you to work with Jason,
Gyewon, and Woo-Yeon.
Jason, Gyewon, and Woo-Yeon have been contributing to REEF. It would be
great if we can add them to committers at some point.
On Fri, Jan 16, 2015 at 1:52 PM, Markus Weimer <ma...@weimo.de> wrote:
> Hi,
>
> I think the website sources need to be hosted on Apache infrastructure
> in a way that grants all committers write access. Otherwise, we set
> ourselves up with a continuous management chore.
>
> Hence, I am in favor of moving the sources to our git repository, if we
> can get a script to do the update of the site set up. Also, just
> managing the site via SVN seems like an ok path as well. We can still
> use JIRA to discuss and approve patches.
>
> Markus
>
>
> On 2015-01-15 17:53, Byung-Gon Chun wrote:
> > Thanks, John.
> >
> > Note that https://github.com/cmssnu/websiteREEF will be moved to a
> public
> > one not under cmssnu if we take this path.
> >
> > All, what do you think about Jason's proposal?
> >
> > On Fri, Jan 16, 2015 at 10:46 AM, John Yang <jo...@gmail.com> wrote:
> >
> >> Hi Professor Chun,
> >>
> >>
> >> sure, currently the code for the website(
> http://reef.incubator.apache.org/
> >> )
> >> is being maintained at a private github repository.
> >>
> >> To use Apache infrastructure for hosting the site, we're using svnpubsub
> >> which automatically checks out updates from
> >> https://svn.apache.org/repos/asf/incubator/reef/ to where the contents
> can
> >> be published to http://reef.incubator.apache.org/.
> >>
> >> So while the code is being managed by git, the generated contents are
> >> deployed by svn. I've written a wiki(access currently restricted to a
> few
> >> people, copy and pasted below) on how to manually bridge this gap, but
> >> wanted to explore alternatives and Jason suggested one that I liked.
> >>
> >>
> >> Thanks,
> >> John
> >>
> >>
> >>
> >>
> >> Contributing to REEF Website Development
> >>
> >> This article covers the process of contributing to the REEF website(
> >> http://reef.incubator.apache.org/) development, from code/apidoc
> editing
> >> to
> >> updating the running site.
> >>
> >>
> >>
> >> 1. Edit (The repo location should be changed)
> >>
> >> *Editing the code*
> >>
> >> The code for the website except the apidoc(
> >> http://reef.incubator.apache.org/apidocs/index.html) is maintained at a
> >> github repository(https://github.com/cmssnu/websiteREEF). Pull the code
> >> from the repository, create a new branch, edit, and file a pull
> request. An
> >> example of a pull request is
> https://github.com/cmssnu/websiteREEF/pull/1.
> >> Editing the apidoc
> >>
> >> As the apidoc is generated from the source code of REEF first you should
> >> make modifications in it and merge the changes into REEF master branch.
> >> Once that's done, register an issue at
> >> https://github.com/cmssnu/websiteREEF/issues to request for an apidoc
> >> update, stating briefly of the changes.
> >>
> >>
> >>
> >> 2. Review
> >>
> >> Request code/apidoc review on the changes to a fellow committer and
> resolve
> >> all issues raised by her.
> >>
> >>
> >>
> >> 3. Update the Website locally (for the reviewers)
> >>
> >> First, svn checkout the existing version of the website using the
> command:
> >> $ svn checkout https://svn.apache.org/repos/asf/incubator/reef/
> >>
> >> This will create a directory named "reef". For convenience, we will
> refer
> >> to this directory as the svn repository from now on.
> >> Updating static contents (except the apidoc)
> >>
> >> After all issues are resolved, merge the branch into master at
> >> https://github.com/cmssnu/websiteREEF, download it and run the
> following
> >> command:
> >> $ mvn clean site:site
> >>
> >> This will generate a directory named "target" and inside, there will be
> a
> >> directory named "site". The site folder contains all HTML files required
> >> for the website and index.html is the default page shown when the
> domain is
> >> first accessed. Move(or copy) the contents into the corresponding
> directory
> >> in the svn repository and be mindful not to delete the
> "reef/site/apidocs"
> >> directory.
> >> Updating apidoc
> >>
> >> After all issues are resolved, close the issue that requested the
> update.
> >> The, at $REEF_HOME run the following command.
> >> $ mvn javadoc:aggregate
> >>
> >> This will create a directory named "apidocs" which includes all the
> >> necessary Javadocs for REEF. Move(or copy) the files inside the
> directory
> >> into the "reef/site/apidocs" directory of the svn repository.
> >>
> >>
> >>
> >> 4. Update the running Website (for the reviewers)
> >> Once 3. is done. You will have an updated version of the website on your
> >> local computer. Re-check the changes using this command:
> >> $ svn diff
> >>
> >>
> >> To update the running website, at the svn repository, use the following
> >> commands:
> >> $ svn commit
> >>
> >> This will push the changes to
> >> https://svn.apache.org/repos/asf/incubator/reef/, which will then be
> >> automatically checked out by svnpubsub, as described in
> >> https://www.apache.org/dev/project-site.html, and then to be published
> at
> >> http://reef.incubator.apache.org/.
> >>
> >>
> >>
> >> On Fri, Jan 16, 2015 at 10:37 AM, Byung-Gon Chun <bg...@gmail.com>
> wrote:
> >>
> >>> John,
> >>>
> >>> Can you also share what the current set up is to give some contexts to
> >>> members?
> >>>
> >>> Thanks.
> >>> -Gon
> >>>
> >>> On Fri, Jan 16, 2015 at 10:24 AM, John Yang <jo...@gmail.com>
> wrote:
> >>>
> >>>> Hi all,
> >>>>
> >>>>
> >>>> I've had a discussion with Jason regarding the collaboration process
> >> for
> >>>> the website development. I've thought about several options such as
> >> using
> >>>> svn directly or using a separate github. But each has the tradeoff
> >>> between
> >>>> review convenience(github issues & PR) and deployment
> >> convenience(manual
> >>>> git-to-svn migration is painful).
> >>>>
> >>>>
> >>>> Jason suggested:
> >>>> "FYI, this is a link to Helix's Improve this Website page:
> >>>> http://helix.apache.org/involved/contribdocs.html Their website
> source
> >>>> code
> >>>> is simply included in their project source code, and thus can be
> >> managed
> >>>> with issues and PRs. They made a script (for committers) to automate
> >> the
> >>>> website publishing mechanism, too. This method could diminish "the
> >>> overhead
> >>>> of moving git-versioned files to svn" mentioned by John."
> >>>> which I liked.
> >>>>
> >>>>
> >>>> What are your thoughts?
> >>>>
> >>>>
> >>>> John
> >>>>
> >>>>
> >>>> On Fri, Jan 9, 2015 at 2:50 PM, Byung-Gon Chun <bg...@gmail.com>
> >> wrote:
> >>>>
> >>>>> 1. Yes. This is common.
> >>>>> 2. For contribution, we can create a link to it from the web site
> >> since
> >>>>> we've been effectively using cwiki instead of duplicating the
> >> content.
> >>>>>
> >>>>> Thanks!
> >>>>>
> >>>>> On Fri, Jan 9, 2015 at 1:32 AM, Markus Weimer <ma...@weimo.de>
> >> wrote:
> >>>>>
> >>>>>> Hi,
> >>>>>>
> >>>>>> I finally had the time to have a look. Great work, everyone! I
> >> have a
> >>>>>> few questions:
> >>>>>>
> >>>>>> 1. The list of people contains affiliations. Is that a common
> >>> thing?
> >>>>>> Apache projects are made up of the individuals, not
> >>>>>> representatives of organizations, that is why I am asking
> >>>>>> 2. Some of the content is taken from the wiki. Mostly the
> >>> contributor
> >>>>>> and related guides.We should decide where these live and
> >> remove
> >>>>>> the other copy. I am fine either way.
> >>>>>>
> >>>>>> Thanks,
> >>>>>>
> >>>>>> Markus
> >>>>>>
> >>>>>> On 2015-01-05 19:27, Byung-Gon Chun wrote:
> >>>>>>> Hi all,
> >>>>>>>
> >>>>>>> http://reef.incubator.apache.org is up and running!
> >>>>>>>
> >>>>>>> Many thanks to Josh, John, Jason, and Yunseong to make this
> >> happen!
> >>>>>>>
> >>>>>>> You can update the page by making changes in
> >>>>>>> https://svn.apache.org/repos/asf/incubator/reef/site/
> >>>>>>>
> >>>>>>> Cheers,
> >>>>>>> -Gon
> >>>>>>>
> >>>>>>
> >>>>>
> >>>>>
> >>>>>
> >>>>> --
> >>>>> Byung-Gon Chun
> >>>>>
> >>>>
> >>>
> >>>
> >>>
> >>> --
> >>> Byung-Gon Chun
> >>>
> >>
> >
> >
> >
>
--
Byung-Gon Chun
Re: reef.incubator.apache.org is up and running!
Posted by Markus Weimer <ma...@weimo.de>.
Hi,
I think the website sources need to be hosted on Apache infrastructure
in a way that grants all committers write access. Otherwise, we set
ourselves up with a continuous management chore.
Hence, I am in favor of moving the sources to our git repository, if we
can get a script to do the update of the site set up. Also, just
managing the site via SVN seems like an ok path as well. We can still
use JIRA to discuss and approve patches.
Markus
On 2015-01-15 17:53, Byung-Gon Chun wrote:
> Thanks, John.
>
> Note that https://github.com/cmssnu/websiteREEF will be moved to a public
> one not under cmssnu if we take this path.
>
> All, what do you think about Jason's proposal?
>
> On Fri, Jan 16, 2015 at 10:46 AM, John Yang <jo...@gmail.com> wrote:
>
>> Hi Professor Chun,
>>
>>
>> sure, currently the code for the website(http://reef.incubator.apache.org/
>> )
>> is being maintained at a private github repository.
>>
>> To use Apache infrastructure for hosting the site, we're using svnpubsub
>> which automatically checks out updates from
>> https://svn.apache.org/repos/asf/incubator/reef/ to where the contents can
>> be published to http://reef.incubator.apache.org/.
>>
>> So while the code is being managed by git, the generated contents are
>> deployed by svn. I've written a wiki(access currently restricted to a few
>> people, copy and pasted below) on how to manually bridge this gap, but
>> wanted to explore alternatives and Jason suggested one that I liked.
>>
>>
>> Thanks,
>> John
>>
>>
>>
>>
>> Contributing to REEF Website Development
>>
>> This article covers the process of contributing to the REEF website(
>> http://reef.incubator.apache.org/) development, from code/apidoc editing
>> to
>> updating the running site.
>>
>>
>>
>> 1. Edit (The repo location should be changed)
>>
>> *Editing the code*
>>
>> The code for the website except the apidoc(
>> http://reef.incubator.apache.org/apidocs/index.html) is maintained at a
>> github repository(https://github.com/cmssnu/websiteREEF). Pull the code
>> from the repository, create a new branch, edit, and file a pull request. An
>> example of a pull request is https://github.com/cmssnu/websiteREEF/pull/1.
>> Editing the apidoc
>>
>> As the apidoc is generated from the source code of REEF first you should
>> make modifications in it and merge the changes into REEF master branch.
>> Once that's done, register an issue at
>> https://github.com/cmssnu/websiteREEF/issues to request for an apidoc
>> update, stating briefly of the changes.
>>
>>
>>
>> 2. Review
>>
>> Request code/apidoc review on the changes to a fellow committer and resolve
>> all issues raised by her.
>>
>>
>>
>> 3. Update the Website locally (for the reviewers)
>>
>> First, svn checkout the existing version of the website using the command:
>> $ svn checkout https://svn.apache.org/repos/asf/incubator/reef/
>>
>> This will create a directory named "reef". For convenience, we will refer
>> to this directory as the svn repository from now on.
>> Updating static contents (except the apidoc)
>>
>> After all issues are resolved, merge the branch into master at
>> https://github.com/cmssnu/websiteREEF, download it and run the following
>> command:
>> $ mvn clean site:site
>>
>> This will generate a directory named "target" and inside, there will be a
>> directory named "site". The site folder contains all HTML files required
>> for the website and index.html is the default page shown when the domain is
>> first accessed. Move(or copy) the contents into the corresponding directory
>> in the svn repository and be mindful not to delete the "reef/site/apidocs"
>> directory.
>> Updating apidoc
>>
>> After all issues are resolved, close the issue that requested the update.
>> The, at $REEF_HOME run the following command.
>> $ mvn javadoc:aggregate
>>
>> This will create a directory named "apidocs" which includes all the
>> necessary Javadocs for REEF. Move(or copy) the files inside the directory
>> into the "reef/site/apidocs" directory of the svn repository.
>>
>>
>>
>> 4. Update the running Website (for the reviewers)
>> Once 3. is done. You will have an updated version of the website on your
>> local computer. Re-check the changes using this command:
>> $ svn diff
>>
>>
>> To update the running website, at the svn repository, use the following
>> commands:
>> $ svn commit
>>
>> This will push the changes to
>> https://svn.apache.org/repos/asf/incubator/reef/, which will then be
>> automatically checked out by svnpubsub, as described in
>> https://www.apache.org/dev/project-site.html, and then to be published at
>> http://reef.incubator.apache.org/.
>>
>>
>>
>> On Fri, Jan 16, 2015 at 10:37 AM, Byung-Gon Chun <bg...@gmail.com> wrote:
>>
>>> John,
>>>
>>> Can you also share what the current set up is to give some contexts to
>>> members?
>>>
>>> Thanks.
>>> -Gon
>>>
>>> On Fri, Jan 16, 2015 at 10:24 AM, John Yang <jo...@gmail.com> wrote:
>>>
>>>> Hi all,
>>>>
>>>>
>>>> I've had a discussion with Jason regarding the collaboration process
>> for
>>>> the website development. I've thought about several options such as
>> using
>>>> svn directly or using a separate github. But each has the tradeoff
>>> between
>>>> review convenience(github issues & PR) and deployment
>> convenience(manual
>>>> git-to-svn migration is painful).
>>>>
>>>>
>>>> Jason suggested:
>>>> "FYI, this is a link to Helix's Improve this Website page:
>>>> http://helix.apache.org/involved/contribdocs.html Their website source
>>>> code
>>>> is simply included in their project source code, and thus can be
>> managed
>>>> with issues and PRs. They made a script (for committers) to automate
>> the
>>>> website publishing mechanism, too. This method could diminish "the
>>> overhead
>>>> of moving git-versioned files to svn" mentioned by John."
>>>> which I liked.
>>>>
>>>>
>>>> What are your thoughts?
>>>>
>>>>
>>>> John
>>>>
>>>>
>>>> On Fri, Jan 9, 2015 at 2:50 PM, Byung-Gon Chun <bg...@gmail.com>
>> wrote:
>>>>
>>>>> 1. Yes. This is common.
>>>>> 2. For contribution, we can create a link to it from the web site
>> since
>>>>> we've been effectively using cwiki instead of duplicating the
>> content.
>>>>>
>>>>> Thanks!
>>>>>
>>>>> On Fri, Jan 9, 2015 at 1:32 AM, Markus Weimer <ma...@weimo.de>
>> wrote:
>>>>>
>>>>>> Hi,
>>>>>>
>>>>>> I finally had the time to have a look. Great work, everyone! I
>> have a
>>>>>> few questions:
>>>>>>
>>>>>> 1. The list of people contains affiliations. Is that a common
>>> thing?
>>>>>> Apache projects are made up of the individuals, not
>>>>>> representatives of organizations, that is why I am asking
>>>>>> 2. Some of the content is taken from the wiki. Mostly the
>>> contributor
>>>>>> and related guides.We should decide where these live and
>> remove
>>>>>> the other copy. I am fine either way.
>>>>>>
>>>>>> Thanks,
>>>>>>
>>>>>> Markus
>>>>>>
>>>>>> On 2015-01-05 19:27, Byung-Gon Chun wrote:
>>>>>>> Hi all,
>>>>>>>
>>>>>>> http://reef.incubator.apache.org is up and running!
>>>>>>>
>>>>>>> Many thanks to Josh, John, Jason, and Yunseong to make this
>> happen!
>>>>>>>
>>>>>>> You can update the page by making changes in
>>>>>>> https://svn.apache.org/repos/asf/incubator/reef/site/
>>>>>>>
>>>>>>> Cheers,
>>>>>>> -Gon
>>>>>>>
>>>>>>
>>>>>
>>>>>
>>>>>
>>>>> --
>>>>> Byung-Gon Chun
>>>>>
>>>>
>>>
>>>
>>>
>>> --
>>> Byung-Gon Chun
>>>
>>
>
>
>
Re: reef.incubator.apache.org is up and running!
Posted by Byung-Gon Chun <bg...@gmail.com>.
Thanks, John.
Note that https://github.com/cmssnu/websiteREEF will be moved to a public
one not under cmssnu if we take this path.
All, what do you think about Jason's proposal?
On Fri, Jan 16, 2015 at 10:46 AM, John Yang <jo...@gmail.com> wrote:
> Hi Professor Chun,
>
>
> sure, currently the code for the website(http://reef.incubator.apache.org/
> )
> is being maintained at a private github repository.
>
> To use Apache infrastructure for hosting the site, we're using svnpubsub
> which automatically checks out updates from
> https://svn.apache.org/repos/asf/incubator/reef/ to where the contents can
> be published to http://reef.incubator.apache.org/.
>
> So while the code is being managed by git, the generated contents are
> deployed by svn. I've written a wiki(access currently restricted to a few
> people, copy and pasted below) on how to manually bridge this gap, but
> wanted to explore alternatives and Jason suggested one that I liked.
>
>
> Thanks,
> John
>
>
>
>
> Contributing to REEF Website Development
>
> This article covers the process of contributing to the REEF website(
> http://reef.incubator.apache.org/) development, from code/apidoc editing
> to
> updating the running site.
>
>
>
> 1. Edit (The repo location should be changed)
>
> *Editing the code*
>
> The code for the website except the apidoc(
> http://reef.incubator.apache.org/apidocs/index.html) is maintained at a
> github repository(https://github.com/cmssnu/websiteREEF). Pull the code
> from the repository, create a new branch, edit, and file a pull request. An
> example of a pull request is https://github.com/cmssnu/websiteREEF/pull/1.
> Editing the apidoc
>
> As the apidoc is generated from the source code of REEF first you should
> make modifications in it and merge the changes into REEF master branch.
> Once that's done, register an issue at
> https://github.com/cmssnu/websiteREEF/issues to request for an apidoc
> update, stating briefly of the changes.
>
>
>
> 2. Review
>
> Request code/apidoc review on the changes to a fellow committer and resolve
> all issues raised by her.
>
>
>
> 3. Update the Website locally (for the reviewers)
>
> First, svn checkout the existing version of the website using the command:
> $ svn checkout https://svn.apache.org/repos/asf/incubator/reef/
>
> This will create a directory named "reef". For convenience, we will refer
> to this directory as the svn repository from now on.
> Updating static contents (except the apidoc)
>
> After all issues are resolved, merge the branch into master at
> https://github.com/cmssnu/websiteREEF, download it and run the following
> command:
> $ mvn clean site:site
>
> This will generate a directory named "target" and inside, there will be a
> directory named "site". The site folder contains all HTML files required
> for the website and index.html is the default page shown when the domain is
> first accessed. Move(or copy) the contents into the corresponding directory
> in the svn repository and be mindful not to delete the "reef/site/apidocs"
> directory.
> Updating apidoc
>
> After all issues are resolved, close the issue that requested the update.
> The, at $REEF_HOME run the following command.
> $ mvn javadoc:aggregate
>
> This will create a directory named "apidocs" which includes all the
> necessary Javadocs for REEF. Move(or copy) the files inside the directory
> into the "reef/site/apidocs" directory of the svn repository.
>
>
>
> 4. Update the running Website (for the reviewers)
> Once 3. is done. You will have an updated version of the website on your
> local computer. Re-check the changes using this command:
> $ svn diff
>
>
> To update the running website, at the svn repository, use the following
> commands:
> $ svn commit
>
> This will push the changes to
> https://svn.apache.org/repos/asf/incubator/reef/, which will then be
> automatically checked out by svnpubsub, as described in
> https://www.apache.org/dev/project-site.html, and then to be published at
> http://reef.incubator.apache.org/.
>
>
>
> On Fri, Jan 16, 2015 at 10:37 AM, Byung-Gon Chun <bg...@gmail.com> wrote:
>
> > John,
> >
> > Can you also share what the current set up is to give some contexts to
> > members?
> >
> > Thanks.
> > -Gon
> >
> > On Fri, Jan 16, 2015 at 10:24 AM, John Yang <jo...@gmail.com> wrote:
> >
> > > Hi all,
> > >
> > >
> > > I've had a discussion with Jason regarding the collaboration process
> for
> > > the website development. I've thought about several options such as
> using
> > > svn directly or using a separate github. But each has the tradeoff
> > between
> > > review convenience(github issues & PR) and deployment
> convenience(manual
> > > git-to-svn migration is painful).
> > >
> > >
> > > Jason suggested:
> > > "FYI, this is a link to Helix's Improve this Website page:
> > > http://helix.apache.org/involved/contribdocs.html Their website source
> > > code
> > > is simply included in their project source code, and thus can be
> managed
> > > with issues and PRs. They made a script (for committers) to automate
> the
> > > website publishing mechanism, too. This method could diminish "the
> > overhead
> > > of moving git-versioned files to svn" mentioned by John."
> > > which I liked.
> > >
> > >
> > > What are your thoughts?
> > >
> > >
> > > John
> > >
> > >
> > > On Fri, Jan 9, 2015 at 2:50 PM, Byung-Gon Chun <bg...@gmail.com>
> wrote:
> > >
> > > > 1. Yes. This is common.
> > > > 2. For contribution, we can create a link to it from the web site
> since
> > > > we've been effectively using cwiki instead of duplicating the
> content.
> > > >
> > > > Thanks!
> > > >
> > > > On Fri, Jan 9, 2015 at 1:32 AM, Markus Weimer <ma...@weimo.de>
> wrote:
> > > >
> > > > > Hi,
> > > > >
> > > > > I finally had the time to have a look. Great work, everyone! I
> have a
> > > > > few questions:
> > > > >
> > > > > 1. The list of people contains affiliations. Is that a common
> > thing?
> > > > > Apache projects are made up of the individuals, not
> > > > > representatives of organizations, that is why I am asking
> > > > > 2. Some of the content is taken from the wiki. Mostly the
> > contributor
> > > > > and related guides.We should decide where these live and
> remove
> > > > > the other copy. I am fine either way.
> > > > >
> > > > > Thanks,
> > > > >
> > > > > Markus
> > > > >
> > > > > On 2015-01-05 19:27, Byung-Gon Chun wrote:
> > > > > > Hi all,
> > > > > >
> > > > > > http://reef.incubator.apache.org is up and running!
> > > > > >
> > > > > > Many thanks to Josh, John, Jason, and Yunseong to make this
> happen!
> > > > > >
> > > > > > You can update the page by making changes in
> > > > > > https://svn.apache.org/repos/asf/incubator/reef/site/
> > > > > >
> > > > > > Cheers,
> > > > > > -Gon
> > > > > >
> > > > >
> > > >
> > > >
> > > >
> > > > --
> > > > Byung-Gon Chun
> > > >
> > >
> >
> >
> >
> > --
> > Byung-Gon Chun
> >
>
--
Byung-Gon Chun
Re: reef.incubator.apache.org is up and running!
Posted by John Yang <jo...@gmail.com>.
Hi Professor Chun,
sure, currently the code for the website(http://reef.incubator.apache.org/)
is being maintained at a private github repository.
To use Apache infrastructure for hosting the site, we're using svnpubsub
which automatically checks out updates from
https://svn.apache.org/repos/asf/incubator/reef/ to where the contents can
be published to http://reef.incubator.apache.org/.
So while the code is being managed by git, the generated contents are
deployed by svn. I've written a wiki(access currently restricted to a few
people, copy and pasted below) on how to manually bridge this gap, but
wanted to explore alternatives and Jason suggested one that I liked.
Thanks,
John
Contributing to REEF Website Development
This article covers the process of contributing to the REEF website(
http://reef.incubator.apache.org/) development, from code/apidoc editing to
updating the running site.
1. Edit (The repo location should be changed)
*Editing the code*
The code for the website except the apidoc(
http://reef.incubator.apache.org/apidocs/index.html) is maintained at a
github repository(https://github.com/cmssnu/websiteREEF). Pull the code
from the repository, create a new branch, edit, and file a pull request. An
example of a pull request is https://github.com/cmssnu/websiteREEF/pull/1.
Editing the apidoc
As the apidoc is generated from the source code of REEF first you should
make modifications in it and merge the changes into REEF master branch.
Once that's done, register an issue at
https://github.com/cmssnu/websiteREEF/issues to request for an apidoc
update, stating briefly of the changes.
2. Review
Request code/apidoc review on the changes to a fellow committer and resolve
all issues raised by her.
3. Update the Website locally (for the reviewers)
First, svn checkout the existing version of the website using the command:
$ svn checkout https://svn.apache.org/repos/asf/incubator/reef/
This will create a directory named "reef". For convenience, we will refer
to this directory as the svn repository from now on.
Updating static contents (except the apidoc)
After all issues are resolved, merge the branch into master at
https://github.com/cmssnu/websiteREEF, download it and run the following
command:
$ mvn clean site:site
This will generate a directory named "target" and inside, there will be a
directory named "site". The site folder contains all HTML files required
for the website and index.html is the default page shown when the domain is
first accessed. Move(or copy) the contents into the corresponding directory
in the svn repository and be mindful not to delete the "reef/site/apidocs"
directory.
Updating apidoc
After all issues are resolved, close the issue that requested the update.
The, at $REEF_HOME run the following command.
$ mvn javadoc:aggregate
This will create a directory named "apidocs" which includes all the
necessary Javadocs for REEF. Move(or copy) the files inside the directory
into the "reef/site/apidocs" directory of the svn repository.
4. Update the running Website (for the reviewers)
Once 3. is done. You will have an updated version of the website on your
local computer. Re-check the changes using this command:
$ svn diff
To update the running website, at the svn repository, use the following
commands:
$ svn commit
This will push the changes to
https://svn.apache.org/repos/asf/incubator/reef/, which will then be
automatically checked out by svnpubsub, as described in
https://www.apache.org/dev/project-site.html, and then to be published at
http://reef.incubator.apache.org/.
On Fri, Jan 16, 2015 at 10:37 AM, Byung-Gon Chun <bg...@gmail.com> wrote:
> John,
>
> Can you also share what the current set up is to give some contexts to
> members?
>
> Thanks.
> -Gon
>
> On Fri, Jan 16, 2015 at 10:24 AM, John Yang <jo...@gmail.com> wrote:
>
> > Hi all,
> >
> >
> > I've had a discussion with Jason regarding the collaboration process for
> > the website development. I've thought about several options such as using
> > svn directly or using a separate github. But each has the tradeoff
> between
> > review convenience(github issues & PR) and deployment convenience(manual
> > git-to-svn migration is painful).
> >
> >
> > Jason suggested:
> > "FYI, this is a link to Helix's Improve this Website page:
> > http://helix.apache.org/involved/contribdocs.html Their website source
> > code
> > is simply included in their project source code, and thus can be managed
> > with issues and PRs. They made a script (for committers) to automate the
> > website publishing mechanism, too. This method could diminish "the
> overhead
> > of moving git-versioned files to svn" mentioned by John."
> > which I liked.
> >
> >
> > What are your thoughts?
> >
> >
> > John
> >
> >
> > On Fri, Jan 9, 2015 at 2:50 PM, Byung-Gon Chun <bg...@gmail.com> wrote:
> >
> > > 1. Yes. This is common.
> > > 2. For contribution, we can create a link to it from the web site since
> > > we've been effectively using cwiki instead of duplicating the content.
> > >
> > > Thanks!
> > >
> > > On Fri, Jan 9, 2015 at 1:32 AM, Markus Weimer <ma...@weimo.de> wrote:
> > >
> > > > Hi,
> > > >
> > > > I finally had the time to have a look. Great work, everyone! I have a
> > > > few questions:
> > > >
> > > > 1. The list of people contains affiliations. Is that a common
> thing?
> > > > Apache projects are made up of the individuals, not
> > > > representatives of organizations, that is why I am asking
> > > > 2. Some of the content is taken from the wiki. Mostly the
> contributor
> > > > and related guides.We should decide where these live and remove
> > > > the other copy. I am fine either way.
> > > >
> > > > Thanks,
> > > >
> > > > Markus
> > > >
> > > > On 2015-01-05 19:27, Byung-Gon Chun wrote:
> > > > > Hi all,
> > > > >
> > > > > http://reef.incubator.apache.org is up and running!
> > > > >
> > > > > Many thanks to Josh, John, Jason, and Yunseong to make this happen!
> > > > >
> > > > > You can update the page by making changes in
> > > > > https://svn.apache.org/repos/asf/incubator/reef/site/
> > > > >
> > > > > Cheers,
> > > > > -Gon
> > > > >
> > > >
> > >
> > >
> > >
> > > --
> > > Byung-Gon Chun
> > >
> >
>
>
>
> --
> Byung-Gon Chun
>
Re: reef.incubator.apache.org is up and running!
Posted by Byung-Gon Chun <bg...@gmail.com>.
John,
Can you also share what the current set up is to give some contexts to
members?
Thanks.
-Gon
On Fri, Jan 16, 2015 at 10:24 AM, John Yang <jo...@gmail.com> wrote:
> Hi all,
>
>
> I've had a discussion with Jason regarding the collaboration process for
> the website development. I've thought about several options such as using
> svn directly or using a separate github. But each has the tradeoff between
> review convenience(github issues & PR) and deployment convenience(manual
> git-to-svn migration is painful).
>
>
> Jason suggested:
> "FYI, this is a link to Helix's Improve this Website page:
> http://helix.apache.org/involved/contribdocs.html Their website source
> code
> is simply included in their project source code, and thus can be managed
> with issues and PRs. They made a script (for committers) to automate the
> website publishing mechanism, too. This method could diminish "the overhead
> of moving git-versioned files to svn" mentioned by John."
> which I liked.
>
>
> What are your thoughts?
>
>
> John
>
>
> On Fri, Jan 9, 2015 at 2:50 PM, Byung-Gon Chun <bg...@gmail.com> wrote:
>
> > 1. Yes. This is common.
> > 2. For contribution, we can create a link to it from the web site since
> > we've been effectively using cwiki instead of duplicating the content.
> >
> > Thanks!
> >
> > On Fri, Jan 9, 2015 at 1:32 AM, Markus Weimer <ma...@weimo.de> wrote:
> >
> > > Hi,
> > >
> > > I finally had the time to have a look. Great work, everyone! I have a
> > > few questions:
> > >
> > > 1. The list of people contains affiliations. Is that a common thing?
> > > Apache projects are made up of the individuals, not
> > > representatives of organizations, that is why I am asking
> > > 2. Some of the content is taken from the wiki. Mostly the contributor
> > > and related guides.We should decide where these live and remove
> > > the other copy. I am fine either way.
> > >
> > > Thanks,
> > >
> > > Markus
> > >
> > > On 2015-01-05 19:27, Byung-Gon Chun wrote:
> > > > Hi all,
> > > >
> > > > http://reef.incubator.apache.org is up and running!
> > > >
> > > > Many thanks to Josh, John, Jason, and Yunseong to make this happen!
> > > >
> > > > You can update the page by making changes in
> > > > https://svn.apache.org/repos/asf/incubator/reef/site/
> > > >
> > > > Cheers,
> > > > -Gon
> > > >
> > >
> >
> >
> >
> > --
> > Byung-Gon Chun
> >
>
--
Byung-Gon Chun
Re: reef.incubator.apache.org is up and running!
Posted by John Yang <jo...@gmail.com>.
Hi all,
I've had a discussion with Jason regarding the collaboration process for
the website development. I've thought about several options such as using
svn directly or using a separate github. But each has the tradeoff between
review convenience(github issues & PR) and deployment convenience(manual
git-to-svn migration is painful).
Jason suggested:
"FYI, this is a link to Helix's Improve this Website page:
http://helix.apache.org/involved/contribdocs.html Their website source code
is simply included in their project source code, and thus can be managed
with issues and PRs. They made a script (for committers) to automate the
website publishing mechanism, too. This method could diminish "the overhead
of moving git-versioned files to svn" mentioned by John."
which I liked.
What are your thoughts?
John
On Fri, Jan 9, 2015 at 2:50 PM, Byung-Gon Chun <bg...@gmail.com> wrote:
> 1. Yes. This is common.
> 2. For contribution, we can create a link to it from the web site since
> we've been effectively using cwiki instead of duplicating the content.
>
> Thanks!
>
> On Fri, Jan 9, 2015 at 1:32 AM, Markus Weimer <ma...@weimo.de> wrote:
>
> > Hi,
> >
> > I finally had the time to have a look. Great work, everyone! I have a
> > few questions:
> >
> > 1. The list of people contains affiliations. Is that a common thing?
> > Apache projects are made up of the individuals, not
> > representatives of organizations, that is why I am asking
> > 2. Some of the content is taken from the wiki. Mostly the contributor
> > and related guides.We should decide where these live and remove
> > the other copy. I am fine either way.
> >
> > Thanks,
> >
> > Markus
> >
> > On 2015-01-05 19:27, Byung-Gon Chun wrote:
> > > Hi all,
> > >
> > > http://reef.incubator.apache.org is up and running!
> > >
> > > Many thanks to Josh, John, Jason, and Yunseong to make this happen!
> > >
> > > You can update the page by making changes in
> > > https://svn.apache.org/repos/asf/incubator/reef/site/
> > >
> > > Cheers,
> > > -Gon
> > >
> >
>
>
>
> --
> Byung-Gon Chun
>
Re: reef.incubator.apache.org is up and running!
Posted by Byung-Gon Chun <bg...@gmail.com>.
1. Yes. This is common.
2. For contribution, we can create a link to it from the web site since
we've been effectively using cwiki instead of duplicating the content.
Thanks!
On Fri, Jan 9, 2015 at 1:32 AM, Markus Weimer <ma...@weimo.de> wrote:
> Hi,
>
> I finally had the time to have a look. Great work, everyone! I have a
> few questions:
>
> 1. The list of people contains affiliations. Is that a common thing?
> Apache projects are made up of the individuals, not
> representatives of organizations, that is why I am asking
> 2. Some of the content is taken from the wiki. Mostly the contributor
> and related guides.We should decide where these live and remove
> the other copy. I am fine either way.
>
> Thanks,
>
> Markus
>
> On 2015-01-05 19:27, Byung-Gon Chun wrote:
> > Hi all,
> >
> > http://reef.incubator.apache.org is up and running!
> >
> > Many thanks to Josh, John, Jason, and Yunseong to make this happen!
> >
> > You can update the page by making changes in
> > https://svn.apache.org/repos/asf/incubator/reef/site/
> >
> > Cheers,
> > -Gon
> >
>
--
Byung-Gon Chun
Re: reef.incubator.apache.org is up and running!
Posted by Markus Weimer <ma...@weimo.de>.
Hi,
I finally had the time to have a look. Great work, everyone! I have a
few questions:
1. The list of people contains affiliations. Is that a common thing?
Apache projects are made up of the individuals, not
representatives of organizations, that is why I am asking
2. Some of the content is taken from the wiki. Mostly the contributor
and related guides.We should decide where these live and remove
the other copy. I am fine either way.
Thanks,
Markus
On 2015-01-05 19:27, Byung-Gon Chun wrote:
> Hi all,
>
> http://reef.incubator.apache.org is up and running!
>
> Many thanks to Josh, John, Jason, and Yunseong to make this happen!
>
> You can update the page by making changes in
> https://svn.apache.org/repos/asf/incubator/reef/site/
>
> Cheers,
> -Gon
>
RE: reef.incubator.apache.org is up and running!
Posted by "Julia Wang (QIUHE)" <Qi...@microsoft.com>.
+1
-----Original Message-----
From: Markus Weimer [mailto:markus@weimo.de]
Sent: Monday, January 05, 2015 11:39 PM
To: dev@reef.incubator.apache.org
Subject: Re: reef.incubator.apache.org is up and running!
Hi,
Awesome, thanks a lot for making that happen!
Markus
On 2015-01-05 19:27, Byung-Gon Chun wrote:
> Hi all,
>
> http://reef.incubator.apache.org is up and running!
>
> Many thanks to Josh, John, Jason, and Yunseong to make this happen!
>
> You can update the page by making changes in
> https://svn.apache.org/repos/asf/incubator/reef/site/
>
> Cheers,
> -Gon
>
Re: reef.incubator.apache.org is up and running!
Posted by Yingda Chen <yd...@gmail.com>.
+1.
On Mon, Jan 5, 2015 at 11:38 PM, Markus Weimer <ma...@weimo.de> wrote:
> Hi,
>
> Awesome, thanks a lot for making that happen!
>
> Markus
>
> On 2015-01-05 19:27, Byung-Gon Chun wrote:
> > Hi all,
> >
> > http://reef.incubator.apache.org is up and running!
> >
> > Many thanks to Josh, John, Jason, and Yunseong to make this happen!
> >
> > You can update the page by making changes in
> > https://svn.apache.org/repos/asf/incubator/reef/site/
> >
> > Cheers,
> > -Gon
> >
>
Re: reef.incubator.apache.org is up and running!
Posted by Markus Weimer <ma...@weimo.de>.
Hi,
Awesome, thanks a lot for making that happen!
Markus
On 2015-01-05 19:27, Byung-Gon Chun wrote:
> Hi all,
>
> http://reef.incubator.apache.org is up and running!
>
> Many thanks to Josh, John, Jason, and Yunseong to make this happen!
>
> You can update the page by making changes in
> https://svn.apache.org/repos/asf/incubator/reef/site/
>
> Cheers,
> -Gon
>