You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@reef.apache.org by Shouheng Yi <sh...@gmail.com> on 2017/01/10 23:55:24 UTC
Adding Build Instructions on the Project Front Page
Hi REEF devs,
Given that http://reef.apache.org is probably the first result when people
search from google and bing, we don't have a direct access to the Github
build page (https://github.com/apache/reef/blob/master/lang/cs/BUILD.md).
Therefore, for the first-timers like me, building and testing REEF has been
a really confusing experience, since the front page and the project wiki
contain little of that information.
I'm purposing adding some links/pages on the front page and wiki to walk
people through in a step-by-step fashion. Any feedback on this idea?
Best,
Shouheng
Re: Adding Build Instructions on the Project Front Page
Posted by Shouheng Yi <sh...@gmail.com>.
Hi Mariia,
Since that JIRA is down today (it says "JIRA is currently being
re-indexed..."), I created a PR (https://github.com/apache/reef/pull/1212)
on github. I added a step-by-step installation guide for people who want to
build REEF .NET by using Windows Command Prompt.
Given that this is my first PR to REEF, any feedback is appreciated. I
followed the instructions here:
https://cwiki.apache.org/confluence/display/REEF/Contributing. Am I missing
anything?
Best,
Shouheng
On Tue, Jan 10, 2017 at 4:12 PM, Mariia Mykhailova <ma...@microsoft.com>
wrote:
> We had a discussion some time ago about what is the best place for REEF
> build/test instructions. The consensus was that build/test instructions are
> applicable to a specific version of code, so they should reside in Github
> to be versioned and updated together with the actual code. In
> https://issues.apache.org/jira/browse/REEF-1275 we've moved instructions
> from wiki to Github.
>
> We can absolutely make these instructions more detailed/step-by-step if
> this is needed (I admit I haven't tried building REEF on Ubuntu so couldn't
> add instructions related to this process) and/or make the links from the
> wiki to build documentation more prominent. If you have a specific
> improvement in mind, feel free to send a pull request/edit cwiki.
>
> -Mariia
>
> -----Original Message-----
> From: Shouheng Yi [mailto:shouhengyi@gmail.com]
> Sent: Tuesday, January 10, 2017 3:55 PM
> To: dev@reef.apache.org
> Subject: Adding Build Instructions on the Project Front Page
>
> Hi REEF devs,
>
> Given that https://na01.safelinks.protection.outlook.com/?url=
> http%3A%2F%2Freef.apache.org&data=02%7C01%7Cmamykhai%40microsoft.com%
> 7C2cb22763b0d846a2fa7908d439b42804%7C72f988bf86f141af91ab2d7cd011
> db47%7C1%7C0%7C636196893304628986&sdata=Y3n1YtbhyIt4mOZFvr%
> 2FnNN1U7msPRByoWnRQfr5Cz%2Bk%3D&reserved=0 is probably the first result
> when people search from google and bing, we don't have a direct access to
> the Github build page (https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Fgithub.com%2Fapache%2Freef%2Fblob%
> 2Fmaster%2Flang%2Fcs%2FBUILD.md&data=02%7C01%7Cmamykhai%40microsoft.com%
> 7C2cb22763b0d846a2fa7908d439b42804%7C72f988bf86f141af91ab2d7cd011
> db47%7C1%7C0%7C636196893304628986&sdata=RdDXFwJRPrWdPwEMqZCUeAQoMc96cW
> skPVAdfXgdsng%3D&reserved=0).
> Therefore, for the first-timers like me, building and testing REEF has
> been a really confusing experience, since the front page and the project
> wiki contain little of that information.
>
> I'm purposing adding some links/pages on the front page and wiki to walk
> people through in a step-by-step fashion. Any feedback on this idea?
>
> Best,
> Shouheng
>
RE: Adding Build Instructions on the Project Front Page
Posted by Mariia Mykhailova <ma...@microsoft.com>.
We had a discussion some time ago about what is the best place for REEF build/test instructions. The consensus was that build/test instructions are applicable to a specific version of code, so they should reside in Github to be versioned and updated together with the actual code. In https://issues.apache.org/jira/browse/REEF-1275 we've moved instructions from wiki to Github.
We can absolutely make these instructions more detailed/step-by-step if this is needed (I admit I haven't tried building REEF on Ubuntu so couldn't add instructions related to this process) and/or make the links from the wiki to build documentation more prominent. If you have a specific improvement in mind, feel free to send a pull request/edit cwiki.
-Mariia
-----Original Message-----
From: Shouheng Yi [mailto:shouhengyi@gmail.com]
Sent: Tuesday, January 10, 2017 3:55 PM
To: dev@reef.apache.org
Subject: Adding Build Instructions on the Project Front Page
Hi REEF devs,
Given that https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Freef.apache.org&data=02%7C01%7Cmamykhai%40microsoft.com%7C2cb22763b0d846a2fa7908d439b42804%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636196893304628986&sdata=Y3n1YtbhyIt4mOZFvr%2FnNN1U7msPRByoWnRQfr5Cz%2Bk%3D&reserved=0 is probably the first result when people search from google and bing, we don't have a direct access to the Github build page (https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fapache%2Freef%2Fblob%2Fmaster%2Flang%2Fcs%2FBUILD.md&data=02%7C01%7Cmamykhai%40microsoft.com%7C2cb22763b0d846a2fa7908d439b42804%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636196893304628986&sdata=RdDXFwJRPrWdPwEMqZCUeAQoMc96cWskPVAdfXgdsng%3D&reserved=0).
Therefore, for the first-timers like me, building and testing REEF has been a really confusing experience, since the front page and the project wiki contain little of that information.
I'm purposing adding some links/pages on the front page and wiki to walk people through in a step-by-step fashion. Any feedback on this idea?
Best,
Shouheng