fix broken links in README.md

[ryan-williams]

seems like building-spark.html was renamed to building-with-maven.html?

Is Maven the blessed build tool these days, or SBT? I couldn't find a building-with-sbt page so I went with the Maven one here.

[AmplabJenkins]

Can one of the admins verify this patch?

[srowen]

No, the reverse actually. The site has not been rebuilt though to expose the new page. This has been asked several times so I hope the site can be refreshed.

[ryan-williams]

I see. Do you want to:

• leave the broken links,
• add some basic "building with sbt" commands to the README, or
• point them at the building-with-maven page per the change here?

[srowen]

The issue is that the docs in master are all consistent, and think contain the correct current state of instructions. But on Github you see master's README.md but the site is course built from branch 1.1. I think the intent is to move build instructions out of README.md more than the reverse since it duplicates the main doc page. It may be too inconvenient to back-port the doc changes to 1.1 and rebuild the site. Maybe an interim solution is to just have both links in README.md. Or slip in a redirect page from the new URL to old right now. Or hey it gets fixed in a month or two with 1.2 anyway.

[ryan-williams]

Interesting. What do you mean by "both links"? The current links to building-spark.html, as well as the building-with-maven.html links I've submitted here? The former currently 404, so keeping them in the README if we are going to the trouble of changing it doesn't make sense to me.

I see now that README.md is not up-to-date, but that was not at all apparent when I was getting set up with Spark over the weekend :-\ Seems like the README should be kept consistent with the source tree that it is committed with, and that can be decoupled from coarser per-release website refreshes. Could we add a couple commands explaining that sbt is blessed now, and showing how to use it? Otherwise maybe the README should just be removed.

[srowen]

So there's an Old page (building-with-maven) and a New page (building-spark). Old redirects to New, and README.md links to New -- in master. But of course only Old exists on the web site since it was generated from branch-1.1. One hacky workaround is to put both links in README now. And later remove the reference to Old. Another workaround is to sneak in a redirect from New to Old right now in the site HTML, which will disappear when it is rereleased.

README.md is up to date actually since it's from master. It's consistent with its source too. It's not consistent with the public site which was built from a previous state of source. The problem is that Github is showing you "HEAD" documentation and the site is not, but both states are consistent with themselves. As if that really helps, but...

It's the reverse -- SBT is not unsupported, but Maven is the main build now, so the effort was to consolidate around Maven build instructions while still leaving in a note about SBT.

[AmplabJenkins]

Can one of the admins verify this patch?

[ryan-williams]

bump. There is still one instance of this broken link that @rxin's commit didn't catch.

[ryan-williams]

ping. @rxin @srowen @JoshRosen

[rxin]

Merging this. Thanks.

[ryan-williams]

np, thanks @rxin !