question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation needs to show version information, careful cache policy

See original GitHub issue

Bug, 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:closed
  • Created 6 years ago
  • Reactions:7
  • Comments:9 (4 by maintainers)

github_iconTop GitHub Comments

9reactions
andrewseguincommented, Oct 9, 2017

I’ve had issue with this as well, especially with the change from md to mat. I see the md docs still on many of my browser sessions, and I need to force-refresh just to get the new stuff.

0reactions
angular-automatic-lock-bot[bot]commented, Sep 8, 2019

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.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Configuring the Apollo Client cache - Apollo GraphQL Docs
This article describes cache setup and configuration. To learn how to interact with cached data, see Reading and writing data to the cache....
Read more >
DefaultCacheBehavior - Amazon CloudFront
A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if request URLs don't match any...
Read more >
Cache-Control - HTTP - MDN Web Docs
The must-understand response directive indicates that a cache should store the response only if it understands the requirements for caching ...
Read more >
`.gitlab-ci.yml` keyword reference - GitLab Docs
Be careful when including a remote CI/CD configuration file. ... See When pipeline artifacts are deleted for more information.
Read more >
Cache Configuration - Ehcache
The Ehcache documentation focuses on XML declarative configuration. ... After a Cache has been started, its configuration is not generally changeable.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found