reef-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Mariia Mykhailova <mamyk...@microsoft.com>
Subject RE: Adding Build Instructions on the Project Front Page
Date Wed, 11 Jan 2017 00:12:25 GMT
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
Mime
View raw message