summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst
diff options
context:
space:
mode:
authorAndrea Visnyei <andrea.visnyei@nokia.com>2020-12-09 12:26:35 +0100
committerEric Debeau <eric.debeau@orange.com>2021-05-06 15:36:12 +0200
commit32d2daf4c1c9a01c6cc6e9b4218b9f4d2650b8e8 (patch)
tree037bd4cf5220935b9f405d3db64e9b5b5e01eafe /docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst
parentc7d15886be96f3036709bb0acc4beb7169e8eec1 (diff)
Template updates - sections
Instructions and examples added, notes commented out, review comments implemented Add example.com in the linkcheck_ignore Issue-ID: DOC-696 Change-Id: I8221ba6f2adce534ced7d8c06fbc7f23eef39efe Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst20
1 files changed, 12 insertions, 8 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst
index 99a061c24..0fcf3153f 100644
--- a/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst
@@ -1,23 +1,27 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2021 ONAP contributors, Nokia
Build
=====
-.. note::
- * This section is used to describe how a software component is built from source
- into something ready for use either in a run-time environment or to build other
- components.
+..
+ * This section is used to describe how a software component is built from
+ source into something ready for use either in a run-time environment or to
+ build other components.
- * This section is typically provided for a platform-component, application, and sdk; and
- referenced in developer guides.
-
- * This note must be removed after content has been added.
+ * This section is typically provided for a platform-component, application,
+ and sdk; and referenced in developer guides.
Environment
-----------
+..
+ List the tools that need to be installed for building the component.
Steps
-----
+
+..
+ List the command(s) that need to be executed for the build.