- Notifications
You must be signed in to change notification settings - Fork7
smartsdk/guided-tour
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Welcome to the guided tour on SmartSDK platform. This guided tour, by means of asmall application example, provides a simple introduction to different servicesdeveloped in the context of SmartSDK project for the FIWARE ecosystem.
Contributions to the documentation are welcome in the form of pull requests.
If you spot any issue in the documentation, you can open an issue, and we willcheck your issue and eventually correct the error in thedocumentation.
ReadTheDocs documentation is generated automatically out ofMarkDown (MD)docs. To ensure consistency of the documentation style, we recommend you toadhere to the MDlinting rules.Compliancy with such rules is checked through a Travis CI process. Once you makea pull request to the repository, you will be able to observe the results ofthe compliancy verification in your PR. Merge will be only possible if the CIprocess passed successfully.
You can check and build the docs by yourself on your machine using acustomdockerimage byrunning the following command in the root directory of the project:
docker run -it --rm -v"$(pwd):/docs" smartsdk/guided-tour-builder
Should you have a solution yourself, feel free to make a pull request!