Skip to content

Commit

Permalink
clean up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lee212 committed Oct 28, 2016
1 parent 8f3dd80 commit 89c38c0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 23 deletions.
20 changes: 5 additions & 15 deletions docs/azure_quickstart_templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -214,9 +214,8 @@ Template Details

Template consists of key elements: metadata, parameters, resources, and
dependson (dependencies) to describe resource deployments. Simple Azure
provides Template() object functions to quickly review template details such as
required parameters, template descriptions and resource information. The
available functions are:
Template() object functions offer to review these template elements and
visualize dependencies. The available functions are:

- [template object].metadata()
- [template object].parameters()
Expand All @@ -230,8 +229,6 @@ Metadata
See metadata of the template ``101-vm-simple-rhel`` from the search results
above:

:

.. code-block:: pycon
>>> rhel_templates['101-vm-simple-rhel'].metadata()
Expand All @@ -256,8 +253,6 @@ variable (metadata().description).

This information is from ``matadata.json`` and returned by Pandas Series

:

::

[template object].metadata() # pandas Series
Expand All @@ -268,8 +263,6 @@ Parameters

We may want to know what parameters are necessary to deploy for this template:

:

.. code-block:: pycon
>>> rhel_templates['101-vm-simple-rhel'].parameters()
Expand All @@ -295,8 +288,6 @@ Resources
According to the metadata earlier, we know that ``101-vm-simple-rhel`` deploys
a virtual machine with Standard D1 but it isn't clear what resources are used.

:

.. code-block:: pycon
>>> rhel_templates['101-vm-simple-rhel'].resources()
Expand Down Expand Up @@ -326,8 +317,6 @@ Services can be related to other services when it deploys, for example,
Dependencies are not visible in ``resources()`` but in ``dependson()`` which
returns its relation in python dict data type using pprint():

:

.. code-block:: pycon
>>> rhel_templates['101-vm-simple-rhel'].dependson_print()
Expand All @@ -341,8 +330,9 @@ returns its relation in python dict data type using pprint():
displayed `here
<http://armviz.io/#/?load=https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-rhel/azuredeploy.json>`_

This information is from ``dependsOn`` section in ``azuredeploy.json`` and
returned by Python dictionary or printed in the Pretty Print (pprint):
The dependencies are retrieved from ``dependsOn`` section in
``azuredeploy.json`` in Python dictionary format (dependson()) and in Pretty
Print format (dependson_print()):

::

Expand Down
8 changes: 0 additions & 8 deletions docs/templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,6 @@ It is actually recommended to use environment variables. Create a file for crede
And then source it before running Python like:

:

.. code-block:: console
$ source ~/.saz/cred
Expand Down Expand Up @@ -193,8 +191,6 @@ We assume that you already have a SSH key pair generated with a default filename
object contains public key string like:


:

.. code-block:: pycon
>>> saz.arm.sshkey.pubkey
Expand All @@ -203,8 +199,6 @@ object contains public key string like:
We provide this as a parameter like:

:

.. code-block:: pycon
>>> saz.arm.set_parameter({"sshKeyData": arm.sshkey.pubkey})
Expand Down Expand Up @@ -238,8 +232,6 @@ You can directly call ``deploy()`` function without setting template
(set_template()) and parameters (set_parameter()) but sending them as function
parameters like (Both ways work same):

:

.. code-block:: pycon
>>> saz.arm.deploy(template_url, parameters)
Expand Down

0 comments on commit 89c38c0

Please sign in to comment.