diff options
| author |   Rich Bennett <rb2745@att.com> | 2017-10-13 15:28:09 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2017-10-13 15:32:13 -0400 |
| commit | dd0f4438e8dea6ef68a043488545e3efcb3fa78a (patch) | |
| tree | ced34525665cc8c4b35a79c0ee7a50290c60240c /docs/developer_guide.rst | |
| parent | 0e89c1fbeb6618a1a4218c7c78506dff6f71dd6d (diff) | |
Minor edits to resturcture text documentation
Improved cross references, bullet lists, and used code-block directive on bash cmds
Added release-notes template
Change-Id: Id12fb1b77ef9690b5b50505e47ec7035039f2f24
Issue-ID: CLI-54
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/developer_guide.rst')
| -rw-r--r-- | docs/developer_guide.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst index 4c10e765..e345e624 100644 --- a/docs/developer_guide.rst +++ b/docs/developer_guide.rst @@ -1,8 +1,9 @@ -.. _developer_guide: .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 Huawei Technologies Co., Ltd. +.. _cli_developer_guide: + CLI developer guide =================== @@ -80,12 +81,12 @@ All ONAP CLI commands can be implemented as YAML using HTTP profile. Follow the steps below to implement new commands in ONAP using YAML: -#. Install the latest ONAP CLI using the guide installation_guide_. +#. Install the latest ONAP CLI using the guide :ref:`cli_installation_guide`. -#. Under the onap-cli-schema folder, add a new YAML file by referring to open_cli_schema_version_1_0_. +#. Under the onap-cli-schema folder, add a new YAML file by referring to :ref:`open_cli_schema_version_1_0`. #. Use the command 'onap schema-validate' to validate the YAML before testing its functionality. #. Run 'onap schema-refresh' command to take the new YAML file. We recommed validating the YAML before running this command. -#. To test this command, run the command 'onap CMD-NAME --help'.
\ No newline at end of file +#. To test this command, run the command 'onap CMD-NAME --help'. |