You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ja...@apache.org on 2018/08/22 21:53:40 UTC
[cordova-contribute] branch janpio-deprecation created (now e8baa8d)
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a change to branch janpio-deprecation
in repository https://gitbox.apache.org/repos/asf/cordova-contribute.git.
at e8baa8d more polish
This branch includes the following new commits:
new 245c8d0 extract actual deprecation policy
new 40183b3 one deprecation notice template is enough
new 90e92b9 simplify
new b7a9763 remove mailing list reference
new 14fdd66 polish
new e8baa8d more polish
The 6 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[cordova-contribute] 06/06: more polish
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a commit to branch janpio-deprecation
in repository https://gitbox.apache.org/repos/asf/cordova-contribute.git
commit e8baa8d9a4151207802a78d76aa9a9375d3276e9
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Aug 22 20:45:03 2018 +0200
more polish
---
deprecation.md | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/deprecation.md b/deprecation.md
index c09e9d0..56f5c37 100644
--- a/deprecation.md
+++ b/deprecation.md
@@ -6,29 +6,29 @@
### 1. Make changes in `README.md`
-Add the [Deprecation Notice Template](#deprecation-notice-templates) to the `README.md` of the project. Add a reason and a link to further information (e.g. blog post, web standard definition etc.).
+Add the [Deprecation Notice Template](#deprecation-notice-template) to the `README.md` of the project. Add a reason and a link to further information (e.g. blog post, web standard definition etc.).
### 2. Request GitHub repository changes
-A [PMC](TODO) member has to [open an issue with Apache INFRA](https://issues.apache.org/jira/browse/INFRA) to request changes to the GitHub repository.
+A PMC member has to [open an issue with Apache INFRA](https://issues.apache.org/jira/browse/INFRA) to request changes to the GitHub repository.
For deprecation:
1. Make sure deprecation notice is in `README.md` and contains all information
-1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request that the repository description is prefixed with `[DEPRECTATED]`
+1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request that the repository description is prefixed with `[DEPRECATED]`
For archiving:
1. Make sure there are no more open Issues and Pull Requests for this repository
-If there are, please close them with this suggested text or similar:
- > TODO
- > We are archiving this repository following our deprecation policy documented at ..TODO..
- > Thanks for your issue or pull request anyway.
- > TODO
+ If there are, please close them with this suggested text or similar:
+ > We are archiving this repository following [Apache Cordova's Deprecation Policy](https://cordova.apache.org/deprecation_policy.html). We won't do any more work on this repository therefore all Issues and Pull Requests are closed. Thanks for your issue or pull request.
+ ```markdown
+ We are archiving this repository following [Apache Cordova's Deprecation Policy](https://cordova.apache.org/deprecation_policy.html). We won't do any more work on this repository therefore all Issues and Pull Requests are closed. Thanks for your issue or pull request.
+ ```
1. Make sure deprecation notice is in `README.md` and contains all information
-1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request a) that the repository description is prefixed with `[DEPRECTATED]` and b) the repository is archived on GitHub
+1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request that a) the repository description is prefixed with `[DEPRECATED]` and b) the repository is archived on GitHub
-## Deprecation Notice Templates
+## Deprecation Notice Template
---
**Deprecation Notice**
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[cordova-contribute] 03/06: simplify
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a commit to branch janpio-deprecation
in repository https://gitbox.apache.org/repos/asf/cordova-contribute.git
commit 90e92b954257db86bc45cf493b89ab18ea530f57
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Aug 22 20:14:27 2018 +0200
simplify
---
deprecation.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/deprecation.md b/deprecation.md
index 52cfbd7..e3b7951 100644
--- a/deprecation.md
+++ b/deprecation.md
@@ -3,7 +3,7 @@
### 1. Make changes in README
-Add the [deprecation or archiving notice template](#deprecation-and-archiving-notice-templates) to the `README.md` of the project.
+Add the [Deprecation Notice Template](#deprecation-notice-templates) to the `README.md` of the project. Add a reason and a link to further information (blog post, web standard definition etc.).
### 2. Request GitHub repository archiving
@@ -12,18 +12,18 @@ To request archiving of a repository, a [PMC](TODO) member has to [open an issue
For deprecation:
1. Make sure deprecation notice is in README and contains all information
-1. Open an issue and request that the repository description is prefixed with [DEPRECTATED]
+1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request that the repository description is prefixed with [DEPRECTATED]
For archiving:
1. Make sure there are no more open issues and Pull Requests for this repository. If there are, please close them with this suggested text or similar:
- > We are archiving this repository following our deprecation policy documented at ..TODO.. Thanks for your issue or pull request anyway.
+ > TODO
+ > We are archiving this repository following our deprecation policy documented at ..TODO..
+ > Thanks for your issue or pull request anyway.
+ > TODO
1. Make sure deprecation notice is in README and contains all information
-1. Open an issue and request a) that the repository description is prefixed with [DEPRECTATED] and b) the repository is archived.
+1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request a) that the repository description is prefixed with [DEPRECTATED] and b) the repository is archived.
-## Deprecation and Archiving notice templates
-
-### Deprecated Repository
## Deprecation Notice Templates
---
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[cordova-contribute] 05/06: polish
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a commit to branch janpio-deprecation
in repository https://gitbox.apache.org/repos/asf/cordova-contribute.git
commit 14fdd66ea401760ffb29012b5fc2610f0eca157c
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Aug 22 20:21:35 2018 +0200
polish
---
README.md | 2 +-
deprecation.md | 26 +++++++++++++++-----------
2 files changed, 16 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 6b25209..135b9ce 100644
--- a/README.md
+++ b/README.md
@@ -8,4 +8,4 @@ This repository contains documents describing everything a contributor of Apache
### Process
-- [Deprecation Policy](deprecation.md)
\ No newline at end of file
+- [Deprecation and Archiving of Repositories](deprecation.md)
\ No newline at end of file
diff --git a/deprecation.md b/deprecation.md
index 8a5c9d3..c09e9d0 100644
--- a/deprecation.md
+++ b/deprecation.md
@@ -1,28 +1,32 @@
+# Deprecation and Archiving
+
+[Apache Cordova's Deprecation Policy](https://cordova.apache.org/deprecation_policy.html) defines why, when and how Cordova projects are deprecated and archived. These are the steps to be taken by a contributor to "execute" such an deprecation:
## Deprecating or Archiving a Repository
-### 1. Make changes in README
+### 1. Make changes in `README.md`
-Add the [Deprecation Notice Template](#deprecation-notice-templates) to the `README.md` of the project. Add a reason and a link to further information (blog post, web standard definition etc.).
+Add the [Deprecation Notice Template](#deprecation-notice-templates) to the `README.md` of the project. Add a reason and a link to further information (e.g. blog post, web standard definition etc.).
-### 2. Request GitHub repository archiving
+### 2. Request GitHub repository changes
-To request archiving of a repository, a [PMC](TODO) member has to [open an issue with Apache INFRA](https://issues.apache.org/jira/browse/INFRA).
+A [PMC](TODO) member has to [open an issue with Apache INFRA](https://issues.apache.org/jira/browse/INFRA) to request changes to the GitHub repository.
For deprecation:
-1. Make sure deprecation notice is in README and contains all information
-1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request that the repository description is prefixed with [DEPRECTATED]
+1. Make sure deprecation notice is in `README.md` and contains all information
+1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request that the repository description is prefixed with `[DEPRECTATED]`
For archiving:
-1. Make sure there are no more open issues and Pull Requests for this repository. If there are, please close them with this suggested text or similar:
+1. Make sure there are no more open Issues and Pull Requests for this repository
+If there are, please close them with this suggested text or similar:
> TODO
> We are archiving this repository following our deprecation policy documented at ..TODO..
> Thanks for your issue or pull request anyway.
> TODO
-1. Make sure deprecation notice is in README and contains all information
-1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request a) that the repository description is prefixed with [DEPRECTATED] and b) the repository is archived.
+1. Make sure deprecation notice is in `README.md` and contains all information
+1. [Open an issue](https://issues.apache.org/jira/browse/INFRA) and request a) that the repository description is prefixed with `[DEPRECTATED]` and b) the repository is archived on GitHub
## Deprecation Notice Templates
@@ -31,7 +35,7 @@ For archiving:
This repository is deprecated and no more work will be done on this by Apache Cordova. You can continue to use this and it should work as-is in the future but any more future issues will not be fixed by the Cordova community.
-Feel free to fork this repository and work on your fork. Existing forks are listed in [Network](network) and [Forks](network/members).
+Feel free to fork this repository and improve your fork. Existing forks are listed in [Network](network) and [Forks](network/members).
- Reason for deprecation: ...
- Learn more: https://example.org/article
@@ -45,7 +49,7 @@ Feel free to fork this repository and work on your fork. Existing forks are list
This repository is deprecated and no more work will be done on this by Apache Cordova. You can continue to use this and it should work as-is in the future but any more future issues will not be fixed by the Cordova community.
-Feel free to fork this repository and work on your fork. Existing forks are listed in [Network](network) and [Forks](network/members).
+Feel free to fork this repository and improve your fork. Existing forks are listed in [Network](network) and [Forks](network/members).
- Reason for deprecation: ...
- Learn more: https://example.org/article
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[cordova-contribute] 01/06: extract actual deprecation policy
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a commit to branch janpio-deprecation
in repository https://gitbox.apache.org/repos/asf/cordova-contribute.git
commit 245c8d0359ed33f0776b784e2e5dc4f709ceee91
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Aug 22 20:13:15 2018 +0200
extract actual deprecation policy
---
deprecation.md | 40 ----------------------------------------
1 file changed, 40 deletions(-)
diff --git a/deprecation.md b/deprecation.md
index 470e9ae..14d6c35 100644
--- a/deprecation.md
+++ b/deprecation.md
@@ -1,43 +1,3 @@
-# Deprecation and Archiving Policy
-
-Apache Cordova has been around quite some time, having been started back in August 2008. As it consists of many individual "parts", some of those stopped being useful for any number of reasons. This "Deprecation and Archiving Policy" describes why, when and how projects can be deprecated and archived - and what that actually means.
-
-## Deprecation Policy
-
-When a piece of Apache Cordova stops being useful or necessary we vote on deprecating it on our [dev mailing list](mailing-lists.md).
-
-### Reasons for Deprecation
-
-Common reasons for deprecation of a piece of Apache Cordova are:
-
-- General availability of a web standard that achieves the same thing
-- A better replacement is available somewhere else
-- Usage of a platform declined to a non relevant level
-- A platform was deprecated itself by its producer
-
-### Meaning of Deprecation
-
-When we deprecate something it means no more work will be done on it. We make the deprecation clearly visible in the project's `README.md` (see [Deprecation notice templates](#deprecation-and-archiving-notice-templates) which might also include a reason and links to alternatives if available) and repository description.
-
-**Users can still use the software** as before, we just put them on notice that the software might break in the future - e.g. with new operating system releases or bugs might be found - and we won't fix this any more.
-
-**Users can also still fork the repository** and create their own bug fixes and even new features. The forks will be discoverable with the GitHub "Network" and "Forks" features. There you can see all forks available and easily spot extra commits people have done in an easy and visual way.
-
-**Cordova might still accept bug fix Pull Requests** on the original repository and create a patch release.
-
-## Archiving Policy
-
-A deprecated repository might also be archived when we won't provide support of any kind (Issues, Pull Requests, any releases) for this piece of software any more. Again the decision is made on our [dev mailing list](mailing-lists.md).
-
-A repository can be deprecated and archived at the same time.
-
-### Meaning of Archiving
-
-Additionally to the points listed in [Meaning of Deprecation](#meaning-of-deprecation), an archived repository is "read only" in any way: No more commits, Issues or Pull Requests are possible.
-
-This is achieved by using GitHub's [archive repositories](https://help.github.com/articles/about-archiving-repositories/) feature:
-
-> When a repository is archived, its issues, pull requests, code, labels, milestones, projects, wiki, releases, commits, tags, branches, reactions, and comments become read-only. To make changes in an archived repository, you must unarchive the repository first.
## Deprecating or Archiving a Repository
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[cordova-contribute] 04/06: remove mailing list reference
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a commit to branch janpio-deprecation
in repository https://gitbox.apache.org/repos/asf/cordova-contribute.git
commit b7a97635a8fa1f367908418290d4444a174aa836
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Aug 22 20:15:15 2018 +0200
remove mailing list reference
---
deprecation.md | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/deprecation.md b/deprecation.md
index e3b7951..8a5c9d3 100644
--- a/deprecation.md
+++ b/deprecation.md
@@ -50,5 +50,4 @@ Feel free to fork this repository and work on your fork. Existing forks are list
- Reason for deprecation: ...
- Learn more: https://example.org/article
---
-> Mailing list discussion on the topic:
-> https://lists.apache.org/thread.html/34369ada22f8a616e90471d38c8fd7def2eb17ff3ddbf4ba0b47987f@%3Cdev.cordova.apache.org%3E
\ No newline at end of file
+```
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[cordova-contribute] 02/06: one deprecation notice template is
enough
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a commit to branch janpio-deprecation
in repository https://gitbox.apache.org/repos/asf/cordova-contribute.git
commit 40183b3dd022350ad9445662d36bb93f48a47c4b
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Wed Aug 22 20:14:05 2018 +0200
one deprecation notice template is enough
---
deprecation.md | 30 ++++++++++++++----------------
1 file changed, 14 insertions(+), 16 deletions(-)
diff --git a/deprecation.md b/deprecation.md
index 14d6c35..52cfbd7 100644
--- a/deprecation.md
+++ b/deprecation.md
@@ -24,33 +24,31 @@ For archiving:
## Deprecation and Archiving notice templates
### Deprecated Repository
+## Deprecation Notice Templates
-```markdown
---
**Deprecation Notice**
-This repo is deprecated. No more development, we still might release security fixes and other necessary patch updates. Please find other way to solve the problem.
-- Reason for deprecation: ...
-- Relevant links: ...
-Feel free to fork this repository and work on your fork. Your fork will show up in https://github.com/apache/cordova-.../network/member where other users can look for updated forks.
-No more work will be done on this plugin by the Cordova development community. You can continue to use this plugin and it should work as-is in the future but any more arising issues will not be fixed by the Cordova community.
+This repository is deprecated and no more work will be done on this by Apache Cordova. You can continue to use this and it should work as-is in the future but any more future issues will not be fixed by the Cordova community.
+
+Feel free to fork this repository and work on your fork. Existing forks are listed in [Network](network) and [Forks](network/members).
+
+- Reason for deprecation: ...
+- Learn more: https://example.org/article
---
-```
-### Archived Repository
+### Markdown
```markdown
---
-**Deprecation and Archiving Notice**
-This repo is archived. No more development.
-GitHub repository is archived, which means no more code changes, issues or pull requests.
-- Reason for deprecation: ...
-- Relevant links: ...
-Feel free to fork this repository and work on your fork.
----
-```
+**Deprecation Notice**
+This repository is deprecated and no more work will be done on this by Apache Cordova. You can continue to use this and it should work as-is in the future but any more future issues will not be fixed by the Cordova community.
+Feel free to fork this repository and work on your fork. Existing forks are listed in [Network](network) and [Forks](network/members).
+
+- Reason for deprecation: ...
+- Learn more: https://example.org/article
---
> Mailing list discussion on the topic:
> https://lists.apache.org/thread.html/34369ada22f8a616e90471d38c8fd7def2eb17ff3ddbf4ba0b47987f@%3Cdev.cordova.apache.org%3E
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org