Skip to content
This repository has been archived by the owner on Apr 12, 2024. It is now read-only.

docs: update end-of-life messages #17177

Merged
merged 1 commit into from
Mar 18, 2022
Merged

Conversation

jelbourn
Copy link
Member

This change updates the messaging about AngularJS end-of-life in several places:

  • Docs homepage
  • Docs banner
  • Security and support pages
  • GitHub README

cc @aaronfrost

@gkalpak am I missing anything here? I also want to update the changelog, but assume that happens automatically as part of the release process?

Copy link
Member

@Splaktar Splaktar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The commit message needs to be updated to something like the following to pass the lint checks:

docs(*): update end-of-life messages

I'm just posting the feedback that I was able to get through so far. I got pulled away and will have to finish reviewing/providing feedback later.

README.md Outdated
Comment on lines 17 to 18
**[Support for legacy AngularJS has fully ended.](https://goo.gle/angularjs-end-of-life)**
**Visit https://github.com/angular/angular for the actively supported Angular framework.**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like just saying "Support for legacy AngularJS has fully ended." is a bit too final and may have low clickability. This may lead to frustrated community members who just rage close the browser rather than clicking on the link and reading it to find out that they have some options for moving forward (in a separate blog post). Because of this, I think that there is still value in having some text and a link to the "Finding a Path Forward with AngularJS" blog post.

Suggested change
**[Support for legacy AngularJS has fully ended.](https://goo.gle/angularjs-end-of-life)**
**Visit https://github.com/angular/angular for the actively supported Angular framework.**
**[Support for legacy AngularJS has fully ended](https://goo.gle/angularjs-end-of-life). [Find a path forward](https://blog.angular.io/finding-a-path-forward-with-angularjs-7e186fdd4429).**
**Visit https://github.com/angular/angular for the actively supported Angular framework.**

or

Suggested change
**[Support for legacy AngularJS has fully ended.](https://goo.gle/angularjs-end-of-life)**
**Visit https://github.com/angular/angular for the actively supported Angular framework.**
**[Support for legacy AngularJS has fully ended](https://goo.gle/angularjs-end-of-life).**
**Learn more about [finding a path forward](https://blog.angular.io/finding-a-path-forward-with-angularjs-7e186fdd4429) for your AngularJS app.**
**Visit https://github.com/angular/angular for the actively supported Angular framework.**

or at least adding some text to give them a reason to click:

Suggested change
**[Support for legacy AngularJS has fully ended.](https://goo.gle/angularjs-end-of-life)**
**Visit https://github.com/angular/angular for the actively supported Angular framework.**
**Support for legacy AngularJS has fully ended. Find out [what End-of-Life means](https://goo.gle/angularjs-end-of-life).**
**Visit https://github.com/angular/angular for the actively supported Angular framework.**

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition to that, I think it would also be useful to include the date when EOL started.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Learn more about finding a path forward for your AngularJS app.

Makes sense to me

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the text to this everywhere:

AngularJS support has officially ended as of January 2022.
[See what ending support means](https://docs.angularjs.org/misc/version-support-status)
and [read the end of life announcement](https://goo.gle/angularjs-end-of-life).

Visit [https://angular.io](https://angular.io) for the actively supported Angular.

Copy link
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are all the places that need updating afaict.

Regarding the changelog, you can manually update it if you want to add an EOL notice. Do we plan on having another release (and if so, what would it include)?

README.md Outdated
Comment on lines 17 to 18
**[Support for legacy AngularJS has fully ended.](https://goo.gle/angularjs-end-of-life)**
**Visit https://github.com/angular/angular for the actively supported Angular framework.**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition to that, I think it would also be useful to include the date when EOL started.

[0]: https://docs.angularjs.org/misc/version-support-status#long-term-support
| Version | Supported | Status | Comments |
| ----------- | ------------------ | --------------------- | ------------------------------------ |
| 1.8.x | :x: | All support ended | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add dates in the comments so that people have a little bit more context.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added "as of January 2022" in the paragraph text above

@@ -146,7 +146,8 @@ <h4 class="search-results-group-heading">{{ key }}</h4>
<div class="navbar-inner">
<div class="container">
<p class="site-notice">
AngularJS is now in Long Term Support (LTS) mode: <a href="https://docs.angularjs.org/misc/version-support-status">Find out more</a>. Explore End Of Life (EOL) options <a href="https://blog.angular.io/finding-a-path-forward-with-angularjs-7e186fdd4429">here</a>.
<a href="https://goo.gle/angularjs-end-of-life">Support for legacy AngularJS has fully ended.</a>
Visit <a href="https://angular.io">https://angular.io</a> for the actively supported Angular.
</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For best visibility for those who need to find extended support:

Find out more</a>. Read the <a href=https://github.com/angular/angular.js/pull/"https://goo.gle/angularjs-end-of-life"> End Of Life announcement.</a>">
AngularJS support has officially ended. <a href="https://docs.angularjs.org/misc/version-support-status">Find out more</a>. Read the <a href="https://goo.gle/angularjs-end-of-life"> End Of Life announcement.</a>

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the text to this everywhere:

AngularJS support has officially ended as of January 2022.
[See what ending support means](https://docs.angularjs.org/misc/version-support-status)
and [read the end of life announcement](https://goo.gle/angularjs-end-of-life).

Visit [https://angular.io](https://angular.io) for the actively supported Angular.

@@ -5,7 +5,8 @@
# AngularJS API Docs

<div class="alert alert-warning">
**On July 1, 2018 AngularJS entered a 3 year Long Term Support period:** [Find out more](misc/version-support-status).
[Support for legacy AngularJS has fully ended](https://goo.gle/angularjs-end-of-life).
Visit [https://angular.io](https://angular.io) for the actively supported Angular.
</div>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this section could go away since the same page has a banner at the top of the page.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd err towards keeping it- doesn't hurt to repeat ourselves.

@@ -146,7 +146,8 @@ <h4 class="search-results-group-heading">{{ key }}</h4>
<div class="navbar-inner">
<div class="container">
<p class="site-notice">
AngularJS is now in Long Term Support (LTS) mode: <a href="https://docs.angularjs.org/misc/version-support-status">Find out more</a>. Explore End Of Life (EOL) options <a href="https://blog.angular.io/finding-a-path-forward-with-angularjs-7e186fdd4429">here</a>.
<a href="https://goo.gle/angularjs-end-of-life">Support for legacy AngularJS has fully ended.</a>
Visit <a href="https://angular.io">https://angular.io</a> for the actively supported Angular.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This "Visit Angular.IO for the actively supported Angular" is not necessary given that right above this section on the index there is a Big Blue button that says "Try The New Angular".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason I put this here is because there's some subset of people that this part of the page and jump to the incorrect conclusion that this is referring to Angular. I'd like to keep this message everywhere to prevent that.

You can read more about these plans in our [blog post announcement](https://blog.angular.io/stable-angularjs-and-long-term-support-7e077635ee9c).

### Extended Long Term Support
[Visit https://angular.io for the actively supported Angular framework](https://angular.io).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The blog link provided contains all of the relevant info that they could want around dates and time frames and reasons, etc. I feel that it would be more informative to have some quick summarized information here. Instead of deleting this entire section, I would propose:

### End Of Life

On December 31, 2021 AngularJS reached End Of Life and is no longer supported. 
The code will remain accessible through 
[Github](https://github.com/angular/angular.js)
[npm](https://www.npmjs.com/package/angular),
[Bower](https://github.com/angular/bower-angular), and 
[CDN](https://code.angularjs.org/1.8.2). 
This website will remain here indefinitely.

As support has ended, all of the git repos for AngularJS have been locked, which means that it 
is no longer possible to report issues in AngularJS. 

Read [the official End Of Life announcement](https://goo.gle/angularjs-end-of-life).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a summary here, PTAL


You can read more about these plans in our [blog post announcement](https://blog.angular.io/stable-angularjs-and-long-term-support-7e077635ee9c).

### Extended Long Term Support
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please leave this header.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added back the header (didn't actually mean to remove it in the first place)

@Splaktar
Copy link
Member

Splaktar commented Feb 10, 2022

Some screenshots from running this locally:

Desktop

Screen Shot 2022-02-10 at 14 06 41
Screen Shot 2022-02-10 at 14 09 21

Pixel 5

Screen Shot 2022-02-10 at 14 07 53
Screen Shot 2022-02-10 at 14 09 41

  • We may need to add a bit more spacing on mobile so that the version picker isn't obscured.

Copy link
Member

@Splaktar Splaktar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM other than the top spacing and overlay conflict on mobile.

The code will remain accessible on [GitHub](https://github.com/angular/angular.js),
[npm](https://www.npmjs.com/package/angular),
[Bower](https://github.com/angular/bower-angular), and
[CDN](https://code.angularjs.org/1.8.2).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the past, and in current documentation, there have been warnings for developers to not use code.angularjs.org as a CDN. Consider changing this label to something like "our release repository" or just "code.angularjs.org".

@jelbourn
Copy link
Member Author

@Splaktar I've changed the top banner message to be inside the same container as the version picker to avoid the overlapping and updated the various top styles to adjust, seems okay now on various viewport sizes. I also made the container opaque because I wouldn't ignore the transparency 😑

I've also changed that "CDN" text to "Release archive".

Comment on lines 152 to 154
<a href="https://goo.gle/angularjs-end-of-life">
read the end of life announcement
</a>.<br>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<a href="https://goo.gle/angularjs-end-of-life">
read the end of life announcement
</a>.<br>
<a href="https://goo.gle/angularjs-end-of-life">read the end of life announcement</a>.<br>

This fixes the space before the period:

Screen Shot 2022-03-10 at 02 16 32

After:
Screen Shot 2022-03-10 at 02 20 02

<a href="https://goo.gle/angularjs-end-of-life">
read the end of life announcement
</a>.<br>
Visit <a href="https://angular.io">https://angular.io</a> for the actively supported
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Visit <a href="https://angular.io">https://angular.io</a> for the actively supported
Visit <a href="https://angular.io">angular.io</a> for the actively supported

The https:// may be unnecessary in the banner, where space is somewhat limited.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed https:// from the link label 👍

Copy link
Member

@mgechev mgechev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the proposed changes by other reviewers, LGTM!

* Docs homepage
* Docs banner
* Security and support pages
* GitHub README
* CHANGELOG
@jelbourn jelbourn merged commit 757d56e into angular:master Mar 18, 2022
jelbourn added a commit that referenced this pull request Mar 18, 2022
* Docs homepage
* Docs banner
* Security and support pages
* GitHub README
* CHANGELOG

(cherry picked from commit 757d56e)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants