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
Comments
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. |
This comment was originally written by @sethladd I think this is just about api.dartlang.org |
This comment was originally written by @kaendfinger Ok thanks :) |
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? |
Set owner to @alan-knight. |
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. |
It shouldn't be too hard. |
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. |
Thanks Alan! Do we need to make any changes to the UI code, or did the CL also remove it from the UI? |
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. |
Added Started label. |
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. |
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. |
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. |
Good use case. How do we decouple the timeless README from the version-number-specific docs? |
A good question. Created dartbug.com/20112 for it. |
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. |
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. |
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.
The text was updated successfully, but these errors were encountered: