diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst index 892e476..fec8cc6 100644 --- a/doc/source/getting_started.rst +++ b/doc/source/getting_started.rst @@ -73,7 +73,7 @@ Supported Features endpoint. 3. YAML Editor for Intermediary YAML: Support runtime editing of missing - site parameters + site parameters, see :ref:`yaml-editor-info` Future Work ----------- diff --git a/doc/source/index.rst b/doc/source/index.rst index b0ec2b9..924681c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -33,3 +33,4 @@ fed to Shipyard for site deployment / updates. getting_started tugboat + yaml-editor diff --git a/doc/source/tugboat.rst b/doc/source/tugboat.rst index 3236128..9851149 100644 --- a/doc/source/tugboat.rst +++ b/doc/source/tugboat.rst @@ -1,4 +1,4 @@ - +.. Copyright 2018 AT&T Intellectual Property. All Rights Reserved. @@ -90,7 +90,7 @@ Example: Tugboat Plugin Usage b) Excel Spec: excel_spec_upstream.yaml c) Site Config: site_config.yaml d) Template_dir: '../examples/templates' - c) Site name: airship-seaworthy + e) Site name: airship-seaworthy 2. Spyglass CLI Command: spyglass -mg -t tugboat -x SiteDesignSpec_v0.1.xlsx -e excel_spec_upstream.yaml -d site_config.yaml -s airship-seaworthy --template_dir= + + Help: + :: + + > yaml-editor --help + Usage: yaml-editor [OPTIONS] + + Options: + -f, --file FILENAME Path with file name to the intermediary yaml file. + [required] + -h, --host TEXT Optional host parameter to run Flask on. + -p, --port INTEGER Optional port parameter to run Flask on. + -s, --string TEXT Text which is required to be changed on yaml file. + --help Show this message and exit. diff --git a/spyglass/utils/editor/editor.py b/spyglass/utils/editor/editor.py index 689b054..d2b9d04 100644 --- a/spyglass/utils/editor/editor.py +++ b/spyglass/utils/editor/editor.py @@ -105,7 +105,7 @@ def run(*args, **kwargs): default='0.0.0.0', type=click.STRING, multiple=False, - help="Optional port parameter to run Flask on." + help="Optional host parameter to run Flask on." ) @click.option( '--port',