Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cleaner urls for dartdoc? #17386

Closed
jmesserly opened this issue Mar 10, 2014 · 14 comments
Closed

cleaner urls for dartdoc? #17386

jmesserly opened this issue Mar 10, 2014 · 14 comments
Labels
type-enhancement A request for a change that isn't a bug

Comments

@jmesserly
Copy link

right now linking to bleeding edge Element.enteredView looks like:

https://api.dartlang.org/apidocs/channels/be/#dart-dom-html.Element@id_enteredView

Seems like we could clean that up. "apidocs" and "channels" are redundant. "edge" would make more sense than "be". #dart-dom-html.Element@id_enteredView uses a mix of dash, at-sign, and underscore to convey information.

Maybe more like:
https://api.dartlang.org/edge/dart.dom.html/Element#enteredView
?

@kevmoo
Copy link
Member

kevmoo commented Mar 17, 2014

Added Pkg-DartDoc label.

@kevmoo
Copy link
Member

kevmoo commented Mar 17, 2014

Removed Area-DartDoc label.
Added Area-Pkg label.

@kevmoo
Copy link
Member

kevmoo commented Apr 7, 2014

Removed Pkg-DartDoc, Area-Pkg labels.
Added Area-DartDocViewer label.

@efortuna
Copy link
Contributor

efortuna commented May 9, 2014

+sethladd
is this possible, or does this get into acquiring additional second level domains like discussed in
http://code.google.com/p/dart/issues/detail?id=17952


cc @sethladd.
Added NeedsInfo label.

@sethladd
Copy link
Contributor

sethladd commented May 9, 2014

dartdocviewer controls the URL space. You could probably drop /apidocs, as long as you had a very easy to recognize pattern for "here's where the docs that we need to get from cloud storage are". We need to leave some URL path room for other resources served by api.dartlang.org.

@kevmoo
Copy link
Member

kevmoo commented May 9, 2014

Issue #17952 has been merged into this issue.


cc @alan-knight.
cc @kwalrath.

@kevmoo
Copy link
Member

kevmoo commented May 9, 2014

From the merged in issue #17952

https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/dart-io

could/should be

https://api.dartlang.org/stable/dart-io

I could also argue that bleeding-edge and dev could be in their own 3rd-tier domains, so we could have

stable: https://api.dartlang.org/dart-io
dev: https://dev-api.dartlang.org/dart-io
be: https://be-api.dartlang.org/dart-io

There are a lot more important issues to resolve in the short term, but I'd argue this is an important fix.

The current URL scheme is a mess.


Added this to the Later milestone.
Added Triaged label.

@sethladd
Copy link
Contributor

sethladd commented May 9, 2014

Can you help explain how the URL scheme is hurting users? I'd argue that URLs don't really matter. SEO matters. Speed matters. UX matters. URLs are even getting hidden in Chrome.

@kevmoo
Copy link
Member

kevmoo commented May 9, 2014

URLs are UI for a lot of folks, I'd argue. Not a huge issue, but an issue.

I switch between dev/be/stable for instance.

We include URLs in emails and IMs.

Clean is good.

@sethladd
Copy link
Contributor

sethladd commented May 9, 2014

If you're editing a URL by hand, I'd argue our UI is busted. :)

@kwalrath
Copy link
Contributor

kwalrath commented May 9, 2014

What Kevin said. Plus, when I insert links into docs, I don't get a good feeling from the long and grody URLs. They seem hacky and like they might not be supported forever. I want to use a concise URL where each part of the path is meaningful.

@kasperl
Copy link

kasperl commented Jul 10, 2014

Removed this from the Later milestone.
Added Oldschool-Milestone-Later label.

@kasperl
Copy link

kasperl commented Aug 4, 2014

Removed Oldschool-Milestone-Later label.

@nicolasgarnier
Copy link
Contributor

This issue has been moved to Github as part of a migration. Please use the Issue on Github going forward: https://github.com/dart-lang/dartdoc-viewer/issues


Added MovedToGithub label.

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

7 participants