Add feature state templates (#3680)

* Add feature state template

* tweak css

* change wording

* apply wording changes to alpha and beta

* tweak dialog css

* tweak code highlighting

* tweak dialog style

* set for_k8s_version default

* tweak dialog ul

* make init containers 1.5 beta for now

* set default dialog width

* revert a:visited color

* force code style

* simplify copy for alpha, beta, stable

* tweak code style

* fix beta dialog title

* fix dialog link a code

* remaining tweaks

* set a:visited color

* Address Steve's feedback

* rename dialog.md to feature-dialog.md

* remove bold from additional feature state text
This commit is contained in:
Andrew Chen
2017-05-09 11:24:43 -07:00
committed by GitHub
parent ae991e8d60
commit ef2c0920d3
7 changed files with 120 additions and 7 deletions
-1
View File
@@ -1 +0,0 @@
***NOTE: This feature is beta in Kubernetes 1.5.***
+28
View File
@@ -0,0 +1,28 @@
<a href="#" id="feature-state-dialog-link" class="ui-state-default ui-corner-all"><span class="ui-icon ui-icon-newwin"></span>{{ dialog_title }}</a>
<div id="feature-state-dialog" title="{{ dialog_title }}">
{{ dialog_content | markdownify }}
</div>
{% raw %}<script>
$(function(){
$( "#feature-state-dialog" ).dialog({
autoOpen: false,
width: {% endraw %}{{ dialog_width | default: "600" }}{% raw %},
buttons: [
{
text: "Ok",
click: function() {
$( this ).dialog( "close" );
}
}
]
});
// Link to open the dialog
$( "#feature-state-dialog-link" ).click(function( event ) {
$( "#feature-state-dialog" ).dialog( "open" );
event.preventDefault();
});
});
</script>{% endraw %}
+13
View File
@@ -0,0 +1,13 @@
{% assign dialog_title = "alpha" %}
{% capture dialog_content %}
This feature is currently in a *alpha* state, meaning:
* The version names contain alpha (e.g. v1alpha1).
* Might be buggy. Enabling the feature may expose bugs. Disabled by default.
* Support for feature may be dropped at any time without notice.
* The API may change in incompatible ways in a later software release without notice.
* Recommended for use only in short-lived testing clusters, due to increased risk of bugs and lack of long-term support.
{% endcapture %}
**FEATURE STATE:** `Kubernetes {{ for_k8s_version | default: page.version }}` {% include feature-dialog.md %}
+14
View File
@@ -0,0 +1,14 @@
{% assign dialog_title = "beta" %}
{% capture dialog_content %}
This feature is currently in a *beta* state, meaning:
* The version names contain beta (e.g. v2beta3).
* Code is well tested. Enabling the feature is considered safe. Enabled by default.
* Support for the overall feature will not be dropped, though details may change.
* The schema and/or semantics of objects may change in incompatible ways in a subsequent beta or stable release. When this happens, we will provide instructions for migrating to the next version. This may require deleting, editing, and re-creating API objects. The editing process may require some thought. This may require downtime for applications that rely on the feature.
* Recommended for only non-business-critical uses because of potential for incompatible changes in subsequent releases. If you have multiple clusters that can be upgraded independently, you may be able to relax this restriction.
* **Please do try our beta features and give feedback on them! After they exit beta, it may not be practical for us to make more changes.**
{% endcapture %}
**FEATURE STATE:** `Kubernetes {{ for_k8s_version | default: page.version }}` {% include feature-dialog.md %}
+10
View File
@@ -0,0 +1,10 @@
{% assign dialog_title = "stable" %}
{% capture dialog_content %}
This feature is *stable*, meaning:
* The version name is vX where X is an integer.
* Stable versions of features will appear in released software for many subsequent versions.
{% endcapture %}
**FEATURE STATE:** `Kubernetes {{ for_k8s_version | default: page.version }}` {% include feature-dialog.md %}