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

Disable "show packages" from api.dartlang.org #19706

Closed
DartBot opened this issue Jun 28, 2014 · 19 comments
Closed

Disable "show packages" from api.dartlang.org #19706

DartBot opened this issue Jun 28, 2014 · 19 comments
Assignees
Labels
type-enhancement A request for a change that isn't a bug

Comments

@DartBot
Copy link

DartBot commented Jun 28, 2014

This issue was originally filed by @sethladd


Now that dartdocs.org is up and running, and building docs for all packages, we can now disable pkg docs on api.dartlang.org. This should simplify our builds, make the builds faster, and make api.dartlang.org faster.

@DartBot
Copy link
Author

DartBot commented Jun 28, 2014

This comment was originally written by @kaendfinger


Does this apply only to api.dartlang.org, or to the dartdoc-viewer too. If I get clarification, I will see what I can do.

@DartBot
Copy link
Author

DartBot commented Jun 28, 2014

This comment was originally written by @sethladd


I think this is just about api.dartlang.org

@DartBot
Copy link
Author

DartBot commented Jun 28, 2014

This comment was originally written by @kaendfinger


Ok thanks :)

@floitschG
Copy link
Contributor

tentatively assigning to Area-site.


Added Area-Site, Triaged labels.

@DartBot
Copy link
Author

DartBot commented Jun 29, 2014

This comment was originally written by @sethladd


This is actually a request for dartdoc viewer and what I think is a custom mod. Can we retriage?

@sethladd
Copy link
Contributor

Set owner to @alan-knight.
Removed Priority-Unassigned, Area-Site labels.
Added Priority-Mei, Area-DartDocViewer labels.

@sethladd
Copy link
Contributor

Hi Alan,

Is the "show packages" easy to remove? Hopefully it simplifies things, now that we can rely on dartdocs.org. I'm also imagining that we'll speed up api.dartlang.org by eliminating a bunch of JSON from those packages :)

Thanks!


Removed Type-Defect, Priority-Mei labels.
Added Type-Enhancement, Priority-Medium labels.

@alan-knight
Copy link
Contributor

It shouldn't be too hard.
https://codereview.chromium.org/385163006/
for not generating them from docgen.

@kevmoo
Copy link
Member

kevmoo commented Jul 11, 2014

We'll need to re-release packages that explicitly define a documentation link – and remove that link.

Then the pub site will "do the right thing" and link to dartdocs.org

We should file blocking bugs for each package where this applies.

@sethladd
Copy link
Contributor

Thanks Alan! Do we need to make any changes to the UI code, or did the CL also remove it from the UI?

@alan-knight
Copy link
Contributor

There was a separate CL for disabling it in the UI. But note that I haven't committed either yet because Kevin indicated there was stuff we should do first.

@alan-knight
Copy link
Contributor

Added Started label.

@alan-knight
Copy link
Contributor

One question is what people should do in writing a README.md. Resolving variables in scope doesn't seem to work there, so for example the Intl README hard-codes links to api.dartlang.org. In dartdocs.org we don't want to link to specific versions, so those would have to be hard-coding the anchor link. But I suspect at some point we'd want dartdocs.org to be searchable and would need to stop using the anchor link, breaking all of those.

@DartBot
Copy link
Author

DartBot commented Jul 18, 2014

This comment was originally written by @sethladd


Good question about the README! Perhaps just link back to the pub page.

I'm wary of building yet another way to browse pub packages on dartdocs.org, so we're keeping it very static. All nav should go through pub.dartlang.org.

@alan-knight
Copy link
Contributor

Ah, linking back to pub.dartlang.org, which shows the README, works nicely for linking to it. But that doesn't give a way of linking from the README to things in the docs.

@sethladd
Copy link
Contributor

Good use case. How do we decouple the timeless README from the version-number-specific docs?

@alan-knight
Copy link
Contributor

A good question. Created dartbug.com/20112 for it.

@sethladd
Copy link
Contributor

As suggested in another thread, we should have redirects for the old pkg API docs. This can be done via the app.yaml / Python code and not a feature of the dartdoc viewer.

@sethladd
Copy link
Contributor

sethladd commented Aug 6, 2014

Checking in... can we commit this? I think we've fixed most/all of our packages READMEs.

Did we add the redirects from api.dartlang.org over to dartdocs.org ?


cc @kevmoo.

@kevmoo kevmoo added type-enhancement A request for a change that isn't a bug and removed type-enhancement labels Mar 1, 2016
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

5 participants