You are viewing a plain text version of this content. The canonical link for it is here.
Posted to devnull@infra.apache.org by "janpio (GitHub)" <gi...@apache.org> on 2018/08/22 19:03:01 UTC
[GitHub] [cordova-docs] janpio opened pull request #878: New
"Deprecation and Archiving Policy"
This PR adds a "Deprecation and Archiving Policy" page to the Cordova website.
Its content is the result of this discussion on the mailing list: https://lists.apache.org/thread.html/34369ada22f8a616e90471d38c8fd7def2eb17ff3ddbf4ba0b47987f@%3Cdev.cordova.apache.org%3E
There will be another PR to another repository later, that will include the steps and notice template required to deprecate a repository. Those texts will refer to this page.
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
```suggestion
**Users can still use the component** as before, we just put them on notice that the software might go away or break in the future - e.g. with new operating system releases or bugs might be found - and we won't fix this any more.
```
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
I know this line might be controversial, so I highlight it.
If majority doesn't want to have this in here, it can simply be removed before merging.
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
```suggestion
```
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
```suggestion
```
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on issue #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
Your "at a more general level" comment unfortunately is 100% off topic here and has to get ignored/forgotten/lost. Please open a new mailing list thread with your suggestions. (Cordova only has 5 supported and 1 experimental platforms - all others are already deprecated and unsupported)
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
```suggestion
Some common reasons for deprecation of a component of Apache Cordova are:
```
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
Exactly, Amazon itself had "deprecated" `fireos` (and switched to more "stock" Android) which meant Cordova could also remove the platform. At least that's how I remember it.
If you have a sentence I could add to the bullet list, I would be fine with adding it of course.
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
I know this will be controversial, so I highlight it. If majority doesn't want to have this in here, it can simply be removed before merging.
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on issue #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
Your "at a more general level" comment is 100% off topic here. Please open a new mailing list thread with your suggestions. (Cordova only has 5 supported and 1 experimental platforms - all others are already deprecated and unsupported)
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
That's what I thought of for "A platform was deprecated itself by its producer" - or what do mean by "dropped out"?
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
```suggestion
A deprecated repository might also be archived if we don't intend to provide support of any kind (Issues, Pull Requests, Releases) for this component any more. This decision is also made on our [dev mailing list](/contact/).
```
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
I know this line will be controversial, so I highlight it.
If majority doesn't want to have this in here, it can simply be removed before merging.
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] brodybits commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "brodybits (GitHub)" <gi...@apache.org>.
- I would add an explicit note to the end of the first sentence that we would no longer support the project and there is a risk of security issues that will never be fixed.
- I would turn part of the second sentence into a bullet list and include an item in the middle that the project would be set to "archived" state on GitHub _(probably with a reference to the Archiving section below)_.
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] brodybits commented on issue #878: New
"Deprecation and Archiving Policy"
Posted by "brodybits (GitHub)" <gi...@apache.org>.
At a more general level:
I would personally be happy to see some more Cordova plugins be taken over by external projects in order to reduce our own support load. I think this and getting rid of old, unsupported platforms would be a positive step towards the "ultimate goal" to "cease to exist" as discussed in #877.
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] Menardi commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "Menardi (GitHub)" <gi...@apache.org>.
```suggestion
As well as the points listed in [Meaning of Deprecation](#meaning-of-deprecation), an archived repository is "read only". This is achieved by using GitHub's [archive repositories](https://help.github.com/articles/about-archiving-repositories/) feature:
```
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
Any other reasons for Deprecation that were applied in the past?
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
```suggestion
title: Apache Cordova Deprecation and Archiving Policy
```
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
Any other reasons for Deprecation that were applied in the past?
(see list below in diff)
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] brodybits commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "brodybits (GitHub)" <gi...@apache.org>.
- I would add an explicit note to the end of the first sentence that we would no longer support the project and there is a risk of security issues that will never be fixed.
- I would turn part of the second sentence into a bullet list and include an item in the middle that the project would be set to "archived" state on GitHub.
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] brodybits commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "brodybits (GitHub)" <gi...@apache.org>.
Thanks for highlighting it. I would vote :-1: since this is exactly the kind of thing we don't want to have to do with deprecated components (repos).
I would favor adding a note that we would be happy to add links to any relevant replacement projects instead.
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
I don't fully follow. Can you just comment some text as a suggestion please?
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] brodybits commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "brodybits (GitHub)" <gi...@apache.org>.
I remember "we" deprecated & dropped support for Amazon since the Amazon folks had dropped out, told people to just do a special Android build.
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] brodybits commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "brodybits (GitHub)" <gi...@apache.org>.
Let's not forget to get rid of the "..." item before merging:)
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio closed pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
[ pull request closed by janpio ]
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
```suggestion
Some common reasons for deprecation of a piece of Apache Cordova are:
```
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] brodybits commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "brodybits (GitHub)" <gi...@apache.org>.
I guess you mean that you do not fully follow my second point. For clarity I will give an idea how I would rework the first paragraph, in a rough form:
> When we deprecate a component it means no more work will be done on it and it will no longer be supported. We make the deprecation clearly visible as follows:
> - mark the component as deprecated in the project's `README.md` (via a "Deprecation Notice")
> - mark the component as deprecated in the repository description.
> - add links to alternatives if available to the "deprecation notice" in `README.md`
> - set the repository to archived state as described in [link to archived section below]
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on issue #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
Your "at a more general level" comment is 100% off topic here.
Please open a new mailing list thread with your suggestions. (Cordova only has 5 supported and 1 experimental platforms - all others are already deprecated and unsupported)
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] brodybits commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "brodybits (GitHub)" <gi...@apache.org>.
I guess I was not clear enough:
- By "Amazon folks" I meant the people who made the `cordova-amazon` platform repo and the people who supported the `cordova-amazon` platform.
- By "dropped out" I meant "quit updating and supporting `cordova-amazon`". This was my understanding from several years ago, way before I was a member. (I was not part of "we" back then.)
For reference:
- <https://github.com/apache/cordova-discuss/issues/32>
- <https://groups.google.com/forum/#!topic/phonegap/6oZfxBc4hPc>
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] brodybits commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "brodybits (GitHub)" <gi...@apache.org>.
I would add the word "Some" at the beginning, to cover for the case where we want to deprecate for any other reasons.
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
```suggestion
```
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org
[GitHub] [cordova-docs] janpio commented on pull request #878: New
"Deprecation and Archiving Policy"
Posted by "janpio (GitHub)" <gi...@apache.org>.
```suggestion
When we deprecate a component it means no more work will be done on it. We make the deprecation clearly visible in the project's `README.md` (via a "Deprecation Notice") and repository description.
```
[ Full content available at: https://github.com/apache/cordova-docs/pull/878 ]
This message was relayed via gitbox.apache.org for devnull@infra.apache.org