Skip to content

Commit

Permalink
docs: note about version reporting not supported in China regions (aw…
Browse files Browse the repository at this point in the history
  • Loading branch information
Doug-AWS authored and Elad Ben-Israel committed Sep 13, 2018
1 parent f96c487 commit a4899e3
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/src/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,8 @@ Use the |cdk| toolkit to view the contents of this app.
See `Environment Variables <https://docs.aws.amazon.com/cli/latest/userguide/cli-environment.html>`_
in the CLI User Guide for details.

.. include:: region-note.rst

The |cdk| toolkit needs to know how to execute your |cdk| app. It requires that the
:code:`--app` command-line option points to an executable program that adheres
to the toolkit's protocol (this is what the **ARGV/STDOUT** boilerplate
Expand Down
16 changes: 16 additions & 0 deletions docs/src/region-note.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
International License (the "License"). You may not use this file except in compliance with the
License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/.
This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied. See the License for the specific language governing permissions and
limitations under the License.
.. note::

The China regions (BJS and ZHY) do not support version reporting.

See :ref:`version-reporting` for more details and how to
:ref:`opt-out <version-reporting-opt-out>`
2 changes: 1 addition & 1 deletion docs/src/tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ The ``AWS::CDK::Metadata`` resource looks like the following:
.. _version-reporting-opt-out:
Opting-out from Version Reporting
---------------------------------
To out-out, use one of the following methods:
Expand Down

0 comments on commit a4899e3

Please sign in to comment.