search

javaee / javaee-spec

Java EE Platform Specification
https://javaee.github.io/javaee-spec
Other
389 stars 69 forks source link

fixed broken links on the readme page #53

Closed prestongarno closed 7 years ago

prestongarno commented 7 years ago

Links to github markdown pages were missing the ".md" extension in the links

bshannon commented 7 years ago

Why do you think the .md extension is required? The links work fine for me as is. Are you getting errors when clicking on the links?

prestongarno commented 7 years ago

@bshannon unless you want to hard-link the .github.io website it's necessary. There's already a repository for the github pages website, this is the dedicated github repository for the spec right? It's broken if you view it on github and click on the links. Github requires the exact URI or exact relative filename to be able to locate it - right now it's giving me a 404 for the markdown pages I updated

bshannon commented 7 years ago

Ok, I see what you're saying. I was only expecting people to view these pages through the github.io URL, where they're presented in proper web site format. The advantage of not including the ".md" was that I could change the format of the page from markdown to html or asciidoc without having to update the links. I didn't expect that viewing the pages in the "code" view of the repository would be used to navigate to the "source code" of the other pages.

prestongarno commented 7 years ago

@bshannon no biggie, didn't know if that was the reason or not so I figured I'd just make a pull request. As far as the .md files viewed on Github go in general though, that's basically how I browse github because it's really easy and right there rendered alongside the project source code (not in this one but others, I guess). Wouldn't have really guessed at first glance that this is from the pages website.

By the way if you don't mind me asking how long ago did most of these projects go public? Was it just a few days ago?

bshannon commented 7 years ago

We moved our projects to GitHub about 6 weeks ago when java.net closed down.

bshannon commented 7 years ago

I think I'm going to reject this pull request because I really want the web site to be bookmarkable without breaking the bookmarks if we change the source language for the web pages. Sorry.

Is there anything I could do to make it more obvious that these pages should be viewed from the github.io site instead of in the code repository view?

prestongarno commented 7 years ago

No worries, the site layout better better anyways. Can't think of anything at the moment though!