API status - Revision history

Tierlieb: /* In development */

2013-08-07T14:04:06Z

In development

← Older revision		Revision as of 14:04, 7 August 2013
Line 16:		Line 16:
	API features can be categorized as follows.		API features can be categorized as follows.

	== In ~~development~~ ==		== In Development ==
	{{Stability-experimental}}		{{Stability-experimental}}

Tierlieb: added templates to decorate the article

2013-08-07T14:03:17Z

added templates to decorate the article

← Older revision		Revision as of 14:03, 7 August 2013
Line 17:		Line 17:

	== In development ==		== In development ==
			{{Stability-experimental}}

	This feature is currently being developed by Open-Xchange. If this is a customer		This feature is currently being developed by Open-Xchange. If this is a customer
Line 30:		Line 31:

	== New ==		== New ==
			{{Stability-unstable}}

	This feature was recently released, is fully tested and considered stable but is		This feature was recently released, is fully tested and considered stable but is in the process of settling. Based on customer experience across a diverse range
	in the process of settling. Based on customer experience across a diverse range
	of production environments it is possible that further changes may be necessary.		of production environments it is possible that further changes may be necessary.
	To indicate this we have defined a separate level from Stable.		To indicate this we have defined a separate level from Stable.
Line 40:		Line 41:

	== Stable ==		== Stable ==
			{{Stability-stable}}

	The feature is considered stable and is fully documented. However it is possible		The feature is considered stable and is fully documented. However it is possible
Line 49:		Line 51:

	== Frozen ==		== Frozen ==
			{{Stability-frozen}}

	This API has been tested extensively in production and is unlikely to be		This API has been tested extensively in production and is unlikely to be
Line 55:		Line 58:

	== Deprecated ==		== Deprecated ==
			{{Stability-deprecated}}

	This feature is known to be problematic, and changes or even removal are		This feature is known to be problematic, and changes or even removal are

John.broomfield at 13:51, 7 August 2013

2013-08-07T13:51:29Z

← Older revision		Revision as of 13:51, 7 August 2013
Line 1:		Line 1:
	<div class="title">~~Feature stability levels~~</div>		<div class="title">API Status</div>
	At Open-Xchange we are continuously improving our products. Most of the time the		At Open-Xchange we are continuously improving our products. Most of the time the
	changes we make will have no side effects on existing installations and 3rd		changes we make will have no side effects on existing installations and 3rd

Tierlieb: moved Feature stability levels to API status: Better naming.

2013-08-07T13:09:29Z

moved Feature stability levels to API status: Better naming.

← Older revision	Revision as of 13:09, 7 August 2013
(No difference)

Tierlieb: John's suggestions

2013-08-07T13:08:22Z

John's suggestions

← Older revision		Revision as of 13:08, 7 August 2013
Line 1:		Line 1:
	<div class="title">Feature stability levels</div>		<div class="title">Feature stability levels</div>
			At Open-Xchange we are continuously improving our products. Most of the time the
			changes we make will have no side effects on existing installations and 3rd
			party software integration. However, sometimes fixing a bug or adding a new
			feature requires changes to the existing API that are not always backwards
			compatible.

	~~Open-Xchange products are continuously improved. Most~~ of ~~the time,~~ these ~~improvements result in~~ changes~~, which~~ have no side-effects on existing installations and integrations with 3rd party software. Unfortunatly, sometimes, fixing a bug or adding a new feature requires changing existing features in a way that breaks backward compatibility.		To help you understand the impact of these changes we have defined the following
			API status list. This page describes each level and indicates how information
	~~To help you stay informed about such changes, and to help you decide, when to deploy them, we mark documentation pages with a stability level~~. This page ~~defines what~~ each ~~stability~~ level ~~means~~ and ~~where you should look for~~ information about ~~current and upcoming~~ changes to ~~the~~ documented ~~feature~~.		about changes to documented features is communicated.

	In creating these levels we were inspired by the [http://nodejs.org/api/documentation.html#documentation_stability_index node.js stability index].		In creating these levels we were inspired by the [http://nodejs.org/api/documentation.html#documentation_stability_index node.js stability index].

			__TOC__

	~~__TOC__~~		API features can be categorized as follows.

	== In development ==		== In development ==
	This feature is currently being developed and may change or be removed in future versions. Please try it out and provide feedback. Due to the low overhead of making changes at this stage, your feedback is more likely to be integrated into the feature, than in the other stability levels.

	Changes will not be announced. Using the ''watch'' function to stay updated may help. We will try to update the documentation concurrently with code changes, but cannot ~~guarantee it~~.		This feature is currently being developed by Open-Xchange. If this is a customer
			request the customer requesting the change will provide feedback. On occasion
			Open-Xchange may solicit input from a wider audience in order to optimize
			feature development for the widest possible audience. Due to the low overhead of
			making changes at this stage feedback is more likely to be integrated into the
			feature than at other status levels.

			Changes will not be announced. Using the watch function to stay updated may
			help. We will try to update the documentation concurrently with code changes,
			but this cannot be guaranteed.

	== New ==		== New ==
	~~This feature was recently released and is in the process of settling. Since changes are more likely due to feedback from first real-world experiences, this is a separate level from Stable.~~

	Changes will not be announced. We recommend using the ''watch'' function for the given page to stay updated.		This feature was recently released, is fully tested and considered stable but is
			in the process of settling. Based on customer experience across a diverse range
			of production environments it is possible that further changes may be necessary.
			To indicate this we have defined a separate level from Stable.

			This feature is documented. Changes will not be announced. We recommend using
			the watch function for the given page to stay updated.

	== Stable ==		== Stable ==
	~~The feature has proven satisfactory, but cleanup in the underlying code may cause minor changes. Backwards-compatibility will be maintained if reasonable.~~

	~~Incompatible~~ changes will be announced in the release notes.		The feature is considered stable and is fully documented. However it is possible
			that cleanup in the underlying code may cause minor changes.
			Backwards-compatibility will be maintained if possible.

			Changes that are not backwards compatible will be announced in the release
			notes.

	== Frozen ==		== Frozen ==
	This API has been tested extensively in production and is unlikely to ~~ever have to change~~. If ~~they~~ do occur ~~anyway, changes~~ will be announced in the release notes two major releases in advance.
			This API has been tested extensively in production and is unlikely to be
			changed. If changes do occur they will be announced in the release notes two
			major releases in advance.

	== Deprecated ==		== Deprecated ==
	This feature is known to be problematic, and changes or even removal are planned. Do not rely on it. Use of the feature may cause warnings. Backwards compatibility should not be expected.
			This feature is known to be problematic, and changes or even removal are
			planned. Do not rely on it. Use of the feature may cause warnings. Backwards
			compatibility should not be expected.

	Changes will not be announced.		Changes will not be announced.

	[[Category:Meta]]		[[Category:Meta]]
			[[Category:AppSuite]]

Viktor.Pracht: /* New */

2013-07-30T16:10:42Z

New

← Older revision		Revision as of 16:10, 30 July 2013
Line 16:		Line 16:

	== New ==		== New ==
	This feature ~~came out just~~ recently and is in the process of settling. Since changes are more likely due to feedback from first real-world experiences, this is a separate level from Stable.		This feature was recently released and is in the process of settling. Since changes are more likely due to feedback from first real-world experiences, this is a separate level from Stable.

	Changes will not be announced. We recommend using the ''watch'' function for the given page to stay updated.		Changes will not be announced. We recommend using the ''watch'' function for the given page to stay updated.

Viktor.Pracht at 16:08, 30 July 2013

2013-07-30T16:08:24Z

← Older revision		Revision as of 16:08, 30 July 2013
Line 1:		Line 1:
	<div class="title">Feature stability levels</div>		<div class="title">Feature stability levels</div>

	~~Documentation for OX components is subject to change since the~~ products are improved ~~continuously~~. ~~To let you know how reliable~~ a ~~documented~~ feature ~~is, we have introduced the following levels to ratethem~~.		Open-Xchange products are continuously improved. Most of the time, these improvements result in changes, which have no side-effects on existing installations and integrations with 3rd party software. Unfortunatly, sometimes, fixing a bug or adding a new feature requires changing existing features in a way that breaks backward compatibility.

	In creating ~~this~~ we were inspired by the [http://nodejs.org/api/documentation.html#documentation_stability_index node.js stability index].		To help you stay informed about such changes, and to help you decide, when to deploy them, we mark documentation pages with a stability level. This page defines what each stability level means and where you should look for information about current and upcoming changes to the documented feature.

			In creating these levels we were inspired by the [http://nodejs.org/api/documentation.html#documentation_stability_index node.js stability index].


	__TOC__		__TOC__

	== ~~Deprecated~~ ==		== In development ==
	This feature is ~~known to~~ be ~~problematic, and changes are planned~~. ~~Do not rely on~~ it. ~~Use~~ of the feature ~~may cause warnings. Backwards compatibility should not be expected~~.		This feature is currently being developed and may change or be removed in future versions. Please try it out and provide feedback. Due to the low overhead of making changes at this stage, your feedback is more likely to be integrated into the feature, than in the other stability levels.

	~~Changes will not be announced.~~		Changes will not be announced. Using the ''watch'' function to stay updated may help. We will try to update the documentation concurrently with code changes, but cannot guarantee it.

	~~== Upcoming ==~~
	~~This feature is currently being developed and may change or be removed in future versions. Please try it out and provide feedback.~~

	Changes will not be announced. Using the ''watch'' function to stay updated may help~~, but we do not guarantee~~ to update the documentation ~~concurrent~~ with code changes.

	== New ==		== New ==
	This feature came out just recently and is in the process of settling~~, but has not yet had~~		This feature came out just recently and is in the process of settling. Since changes are more likely due to feedback from first real-world experiences, this is a separate level from Stable.
	~~sufficient~~ real-world ~~testing to be considered stable~~.

	Changes will not be announced. We recommend using the ''watch'' function for the given page to stay updated.		Changes will not be announced. We recommend using the ''watch'' function for the given page to stay updated.

	== Stable ==		== Stable ==
	The ~~API~~ has proven satisfactory, but cleanup in the underlying code may cause minor changes. Backwards-compatibility will be maintained if reasonable.		The feature has proven satisfactory, but cleanup in the underlying code may cause minor changes. Backwards-compatibility will be maintained if reasonable.

	Incompatible changes will be announced in the release notes.		Incompatible changes will be announced in the release notes.
Line 31:		Line 27:
	== Frozen ==		== Frozen ==
	This API has been tested extensively in production and is unlikely to ever have to change. If they do occur anyway, changes will be announced in the release notes two major releases in advance.		This API has been tested extensively in production and is unlikely to ever have to change. If they do occur anyway, changes will be announced in the release notes two major releases in advance.

			== Deprecated ==
			This feature is known to be problematic, and changes or even removal are planned. Do not rely on it. Use of the feature may cause warnings. Backwards compatibility should not be expected.

			Changes will not be announced.

	[[Category:Meta]]		[[Category:Meta]]

Tierlieb: A preview for John, who might want to weigh in on the wording

2013-07-30T15:00:43Z

A preview for John, who might want to weigh in on the wording

New page

<div class="title">Feature stability levels</div>

Documentation for OX components is subject to change since the products are improved continuously. To let you know how reliable a documented feature is, we have introduced the following levels to ratethem.

In creating this we were inspired by the [http://nodejs.org/api/documentation.html#documentation_stability_index node.js stability index].

__TOC__

== Deprecated ==
This feature is known to be problematic, and changes are planned. Do not rely on it. Use of the feature may cause warnings. Backwards compatibility should not be expected.

Changes will not be announced.

== Upcoming ==
This feature is currently being developed and may change or be removed in future versions. Please try it out and provide feedback.

Changes will not be announced. Using the ''watch'' function to stay updated may help, but we do not guarantee to update the documentation concurrent with code changes.

== New ==
This feature came out just recently and is in the process of settling, but has not yet had
sufficient real-world testing to be considered stable.

Changes will not be announced. We recommend using the ''watch'' function for the given page to stay updated.

== Stable ==
The API has proven satisfactory, but cleanup in the underlying code may cause minor changes. Backwards-compatibility will be maintained if reasonable.

Incompatible changes will be announced in the release notes.

== Frozen ==
This API has been tested extensively in production and is unlikely to ever have to change. If they do occur anyway, changes will be announced in the release notes two major releases in advance.

[[Category:Meta]]