Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/telefonicaid/thinking-cities
Repository to store and manage end user documentation related to the Telefonica SmartCities Stack. See http://thinking-cities.readthedocs.io
https://github.com/telefonicaid/thinking-cities
fiware iot
Last synced: 3 days ago
JSON representation
Repository to store and manage end user documentation related to the Telefonica SmartCities Stack. See http://thinking-cities.readthedocs.io
- Host: GitHub
- URL: https://github.com/telefonicaid/thinking-cities
- Owner: telefonicaid
- Created: 2015-07-15T12:28:17.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T15:17:02.000Z (5 months ago)
- Last Synced: 2024-08-27T16:11:48.182Z (5 months ago)
- Topics: fiware, iot
- Language: Java
- Homepage:
- Size: 12.5 MB
- Stars: 9
- Watchers: 13
- Forks: 9
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Security: docs/security.md
Awesome Lists containing this project
README
# Thinking Cities
Repository to store and manage end user documentation related to the Telefónica's Thinking Cities platform powered by FIWARE.
## 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:
```
sudo 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:
```
git 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
```
./prepare_release.py -v -d docs/ -c iotpv4.2.conf
```
* Check that the script has done its job correctly
```
git diff
```
* Commit all changes
```
git add docs/*.md
git add docs/topics/*.md
git status # check all the files are staged for commit
git commit
```
* Push to origin
```
git push origin release/v4.2
```
* Check at http://thinking-cities.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:
```
[branches]
repo-name1=release/1.1.0
repo-name2=release/1.2.0
repo-name3=release/1.3.0
...
repo-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.