telefonicaid/fiware-iot-stack

Name: fiware-iot-stack

Owner: Telefónica I+D

Description: Repository to store and manage end user documentation related to the IoT Stack

Created: 2015-07-15 12:28:17.0

Updated: 2018-04-12 13:31:29.0

Pushed: 2018-04-12 13:31:31.0

Homepage: null

Size: 11457

Language: Python

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

fiware-iot-stack

Repository to store and manage end user documentation related to the IoT Stack FIWARE based

How to generate documentation for a specific release

Requirements:

• Python 2.7 (it may work with other versions but I haven't tested)
• Required Python modules: requests and configparser, that can ben installed typically using:

 pip install requests configparser

Assuming you are in master branch with everything ready to release (v4.2 is a fictional example):

• Create the release branch:

checkout -b release/v4.2

• Adjust URLs to point to the right version of the components included in that release. This is done automatically by the prepare_release.py using as input the repo-to-version configuration file

epare_release.py -v -d docs/ -c iotpv4.2.conf

• Check that the script has done its job correctly

diff

• Commit all changes

add docs/*.md
add docs/topics/*.md
status   # check all the files are staged for commit
commit

• Push to origin

push origin release/v4.2

• Check at http://fiware-iot-stack.readthedocs.io/en/master/ that the new release is there (otherwise review the RTD configuration)

Configuration file syntax

The configuration file (iotpv4.2.conf in the example above) uses the following syntax:

nches]
-name1=release/1.1.0
-name2=release/1.2.0
-name3=release/1.3.0

-nameN=release/1.4.0

The 1.1.0, 1.2.0, etc. above are just example; use actual version number in a real case.