Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

Commit

Permalink
docs(eol): updates for End-of-Life
Browse files Browse the repository at this point in the history
- change LTS section of README to an End-of-Life section
  - remove LTS details
- add link to AngularJS EOL blog post
- remove release and contributing docs from README
  - remove Gitter and Google Groups forum links as they will no longer be supported
- update Copyright year in LICENSE
- fix broken Ionic v1 link
- remove README contributing link, forums link, and Gitter link from Getting Started page
  • Loading branch information
Splaktar committed Mar 3, 2022
1 parent 6ec3454 commit b41310d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 93 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License

Copyright (c) 2020 Google LLC. https://angularjs.org
Copyright (c) 2022 Google LLC. https://angularjs.org

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
71 changes: 5 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Material Design for AngularJS Apps
[![npm version](https://badge.fury.io/js/angular-material.svg)](https://www.npmjs.com/package/angular-material)
[![Build Status](https://travis-ci.org/angular/material.svg)](https://travis-ci.org/angular/material)
[![Gitter](https://badges.gitter.im/angular/material2.svg)](https://gitter.im/angular/material?utm_source=badge&utm_medium=badge)

[Material Design](https://material.io/archive/guidelines/) is a specification for a
unified system of visual, motion, and interaction design that adapts across different devices. Our
Expand All @@ -16,24 +15,13 @@ For an implementation of the [Material Design Specification (2018+)](https://mat
please see the [Angular Material](https://material.angular.io/) project which is built for
[Angular](https://angular.io) (v2+) developers.

### <a name="lts"></a> Long Term Support
### <a name="lts"></a> End-of-Life

AngularJS Material has entered a Long Term Support (LTS) period which ends on December 31st, 2021.
This date aligns with the
[AngularJS LTS](https://docs.angularjs.org/misc/version-support-status) period.
AngularJS Material support has officially ended as of January 2022. This date aligns with the end of
the [AngularJS LTS](https://docs.angularjs.org/misc/version-support-status) period. Read the
[end-of-life announcement](https://goo.gle/angularjs-end-of-life) for more details.

We now focus exclusively on providing fixes to bugs, in the 1.2.x branch of the library, that
satisfy at least one of the following criteria:
- We receive a report of, or detect, a security weakness which is then verified
- A major browser releases a version that will cause current production applications
to stop working
- The [jQuery library](https://jquery.com/) releases a version that will cause
current production applications to stop working

AngularJS Material 1.1.x will get a new version, if and only if, we verify a new severe security
weakness.

Learn how to report security issues
Find details on reporting security issues
[here](https://github.com/angular/material/blob/master/SECURITY.md).

![venn diagram](https://cloud.githubusercontent.com/assets/210413/5077572/30dfc2f0-6e6a-11e4-9723-07c918128f4f.png)
Expand All @@ -43,7 +31,6 @@ AngularJS Material includes a rich set of reusable, well-tested, and accessible
Quick Links:

* [API & Demos](#demos)
* [Contributing](#contributing)
* [Building](#building)
* [Installing](#installing)

Expand All @@ -70,54 +57,6 @@ AngularJS Material supports the screen reader versions listed
- Or you can build the documentation and demos locally; see
[Build Docs & Demos](https://github.com/angular/material/tree/master/docs/README.md) for details.


## <a name="releasing"></a> Our Release Processes

To preserve stability with applications currently using AngularJS Material, we do not follow semver.
We have three types of releases:

* `major` : major releases will be done in the separate [Angular Material](https://github.com/angular/components) repo.
This type of release will not be used within AngularJS Material.
* `minor`: contain breaking changes in addition to patch release changes.
* `patch`: non-breaking changes (no API, CSS, UX changes that will cause breaks in existing AngularJS Material applications).

##### Patch Releases

The patch builds (1.2.1, 1.2.2, etc.) are prepared based on commits in the `master` branch;
which contains only non-breaking changes (I.e. bug fixes, new features, API additions, and minimal
non-breaking CSS changes). We are targeting `patch` releases every 2 weeks.

##### Minor Releases

The minor builds (1.1.0, 1.2.0, 1.3.0) can contain breaking changes to CSS, APIs, and UX.
Our formal release of `minor` builds is much less frequent. The release process for `minor` builds is currently
being re-evaluated.

> For the purposes of AngularJS Material, you *could* think of the patch releases as being *minor* changes,
and the 'minor' releases as being *major* changes according to semver.

## <a name="contributing"></a> Contributing

Developers interested in contributing should read the following guidelines:

- [Issue Guidelines](.github/CONTRIBUTING.md#submit)
- [Contributing Guidelines](.github/CONTRIBUTING.md)
- [Coding Guidelines](docs/guides/CODING.md)
- [Pull Request Guide](docs/guides/PULL_REQUESTS.md)
- [Software Process](docs/guides/COMMIT_LEVELS.md)
- [Change Log](CHANGELOG.md)

> Please do **not** ask general questions in an issue. Issues are only to report bugs, request
enhancements, or request new features. For general questions and discussions, use the
[AngularJS Material Forum](https://groups.google.com/forum/#!forum/ngmaterial).

It is important to note that for each release, the [ChangeLog](CHANGELOG.md) is a resource that will
itemize all:

- Bug Fixes
- New Enhancements
- Breaking Changes

## <a name="building"></a> Building

Developers can build AngularJS Material using NPM and gulp.
Expand Down
30 changes: 4 additions & 26 deletions docs/app/partials/getting-started.tmpl.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h2><em>New to AngularJS?</em> Before getting into AngularJS Material, it might
<h2>How do I start with AngularJS Material?</h2>
<ul style="margin-bottom: 2em;">
<li>
Get jump started with a free 30 minute video course: <a
Get jump started with a free 30-minute video course: <a
href="https://egghead.io/courses/introduction-to-angular-material" target="_blank"
title="AngularJS Framework">Introduction to AngularJS Material</a>
</li>
Expand Down Expand Up @@ -110,41 +110,19 @@ <h3>Unsupported Integrations</h3>
</li>

<li>
<a href="http://legacy.docs.ionic.io/v1.0">Ionic v1</a>
<a href="https://ionicframework.com/docs/v1/overview/">Ionic v1</a>
- Has built-in touch support that interferes with AngularJS Material's mobile gesture features.
Ionic v1 is no longer officially supported by the Ionic team.
</li>
</ul>

<br/>
<h2>Contributing to AngularJS Material</h2>
<h2>Getting help with AngularJS Material</h2>
<ul style="margin-bottom: 2em;">
<li>
Start by reading our <a href="https://github.com/angular/material#contributing">Contributor
Guidelines</a>.
</li>
<li>
For bug reports, search our
<a href="https://github.com/angular/material/issues?q=is%3Aissue+is%3Aopen"
target="_blank" title="AngularJS Material GitHub Issues">GitHub Issues</a>
for existing issues that match your bug.
</li>
<li style="margin-left: 40px">If none are found, please open a new issue.</li>
<li>For questions and troubleshooting, search the
<a href="https://groups.google.com/forum/#!forum/ngmaterial"
target="_blank" title="AngularJS Material Forums">AngularJS Material Forums</a>
for related discussions.
</li>
<li style="margin-left: 40px">If none are found, please post a new question.</li>
<li>StackOverflow's
<a href="https://stackoverflow.com/questions/tagged/angularjs-material" target="_blank"
title="AngularJS Material tag on StackOverflow">
[angularjs-material] tag</a> is another good resources for solving problems.
</li>
<li>
You can also ask questions in our
<a href="https://gitter.im/angular/material" target="_blank" title="Gitter Chat">
Gitter Chat</a>.
[angularjs-material] tag</a> is a good resources for solving problems.
</li>
</ul>
</md-content>
Expand Down

0 comments on commit b41310d

Please sign in to comment.