Documentation needs to show version information, careful cache policy
See original GitHub issueBug, feature request, or proposal:
Bug
What is the expected behavior?
Visiting a page under the official docs (e.g. https://material.angular.io/components/tabs/overview
) should a) show the latest information about a component and b) tell you what version / release it applies to somewhere on the page.
What is the current behavior?
The page says nothing about what version it applies to. Critically, the page is aggressively cached, so unless a user force-refreshes the page, they may be looking at old versions of the docs that reference directives / parameters / whatever that don’t exist anymore or have changed. I’m not sure how the “Edit in Plunker” link works under the hood but somehow the old page links to an older version of the Plunker that includes older code syntax, which does not work against the current build of the library. The end result is that users will find that examples (appear to) just mysteriously stop working one day.
What are the steps to reproduce?
Open all the pages in the documentation, then wait until a major revision changes a bunch of syntax, then go back to the page and find that it reflects the old syntax, with links to examples that are also still written in the old syntax.
What is the use-case or motivation for changing an existing behavior?
I would like to not waste an entire day trying to figure out “why all these Plunkers broke out of the blue”.
Is there anything else we should know?
The examples don’t link a specific version of Angular or Material in their systemjs.config.js
, e.g.:
'@angular/material': 'https://unpkg.com/@angular/material/bundles/material.umd.js',
This means that old examples will blithely load the new version of the code and just stop working. All examples should use a config file that points to a specific version of all dependencies, but especially the dependency they’re trying to demonstrate (i.e. Material).
Issue Analytics
- State:
- Created 6 years ago
- Reactions:7
- Comments:9 (4 by maintainers)
Top GitHub Comments
I’ve had issue with this as well, especially with the change from
md
tomat
. I see themd
docs still on many of my browser sessions, and I need to force-refresh just to get the new stuff.This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem.
Read more about our automatic conversation locking policy.
This action has been performed automatically by a bot.