Skip to content

Commit

Permalink
new titles and structure of howto section--#56
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefano David committed Jun 7, 2019
1 parent 5d9a26f commit e385377
Show file tree
Hide file tree
Showing 9 changed files with 37 additions and 42 deletions.
33 changes: 17 additions & 16 deletions source/howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ information about each of them is provided.
howto/mobility
howto/tourism/getstarted
howto/tourism/browse
howto/tourism/tips
howto/authentication
howto/development
howto/postman
howto/noievents
howto/tourism/tips


*****
Expand All @@ -32,24 +32,25 @@ information about each of them is provided.
.. rubric:: Tourism


#. :doc:`/howto/tourism/getstarted`. This howto describes the various
filters available in the Tourism domain
#. :doc:`/howto/tourism/browse`. This howto provides information about
accessing the data originating from the Tourism domain.
#. :doc:`/howto/tourism/tips`. This howto provides some simple use cases/API
calls and various tricks&tips for the Tourism domain.
#. :doc:`/howto/tourism/getstarted` Description of how to access and
manipulate data, the input data used, and the various filters
available in the Tourism domain.
#. :doc:`/howto/tourism/browse` Access to the open data provided
within the Tourism domain.
#. :doc:`/howto/tourism/tips` Mini howtos, tricks&tips, and use cases
for data in the Tourism domain.

.. rubric:: Miscellaneous

#. :doc:`/howto/authentication`. Developers and Code Contributors
have a dedicated tutorial to help them bootstrapping the
environment and start coding right away.
#. :doc:`/howto/authentication` Access to data that are not yet open
(mostly for internal use).

#. :doc:`/howto/development`. This tutorial is still in development and
not so useful at the moment!
#. :doc:`/howto/development` Set up your workstation to develop for
|odh|--This tutorial is still in development and not so useful at
the moment!

#. :doc:`/howto/postman`. This howto guides you in the setup of Postman,
a popular API development environment.
#. :doc:`/howto/postman` Setup of Postman, a popular API development
environment, to access data from the |odh|.

#. :doc:`/howto/noievents`. In this howto you will learn how to enter
and modify NOI events directly from the |odh| portal.
#. :doc:`/howto/noievents` Create and modify NOI events directly from
the |odh| portal.
4 changes: 2 additions & 2 deletions source/howto/authentication.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _authentication-howto:

How to use authentication
=========================
How to use authentication?
==========================

As described in section :ref:`authentication`, there are two methods
to access protected data in the dataset: Bearer Token Login and OAuth2
Expand Down
4 changes: 2 additions & 2 deletions source/howto/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
.. _development:

How to setup your local Development Environment
===============================================
How to set up your local Development Environment?
================================================

This tutorial will guide you in the setup of the local infrastructure
to be able to deploy, on top of the Big Data Platform, a new Data
Expand Down
11 changes: 2 additions & 9 deletions source/howto/mobility.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,11 @@

HOWTO access e-Charging Stations Data
-------------------------------------
How to access e-Charging Stations Data?
---------------------------------------

This howto uses the :ref:`E-charging stations dataset <echarging-dataset>`
to showcase a few basic API calls, whose output will be needed in most
complex calls.

..
.. note:: This howto is a stub and will be used mostly to collect
feedback. It is however structured like my idea for these howots
and contains almost all the parts that IMHO should be contained in
the howtos that should be ready for our first milestone.

Dataset Information
~~~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions source/howto/noievents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
.. role:: greenbtn
.. role:: blackbtn

How to insert and modify NOI Events
===================================
How to insert and modify NOI Events?
====================================

After reading this article, you will be able to use the |odh| tourism
portal to insert, modify, and delete events that take place at NOI
Expand Down
2 changes: 1 addition & 1 deletion source/howto/postman.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. role:: orange

How to Sett Up Postman (API Development Environment)
How to set up Postman (API Development Environment)?
-----------------------------------------------------

Postman is a popular API development environment, that is, a tool that
Expand Down
4 changes: 2 additions & 2 deletions source/howto/tourism/browse.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
HOWTO use the Open Data Hub's Tourism Data Browser
==================================================
How to use the Open Data Hub's Tourism Data Browser?
====================================================

This how to explains the necessary steps to access and retrieve data
from the |odh|'s tourism domain.
Expand Down
13 changes: 7 additions & 6 deletions source/howto/tourism/getstarted.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
.. |li| replace:: :literal:`{Id}`


HOWTO access Tourism Data
=========================
How to access Tourism Data?
===========================


.. note:: Information in this page might change in the next future.
.. note:: Information in this page might be updated and improved in
the next future.

The purpose of this howto is to quickly introduce the structure of the
API calls, the available filters for the datasets in the Tourism
domain, and give some general and useful information about the Tourism
API.


.. include:: /howto/tourism/access.rst

.. structure of the API Calls
.. _tourism-api-call-structure:
Expand Down Expand Up @@ -148,5 +151,3 @@ strings, dates, and integers.
language, enter :strong:`it`, :strong:`de`, or :strong:`en`,
respectively.


.. include:: /howto/tourism/access.rst
4 changes: 2 additions & 2 deletions source/howto/tourism/tips.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Quick and (not-so) Dirty Tips for Tourism
-----------------------------------------
Quick and (not-so) Dirty Tips for Tourism (AKA Mini-howtos)
-----------------------------------------------------------

This section contains various tips and tricks to improve and tweak the
queries sent to the Tourism datasets, allowing more precise results to
Expand Down

0 comments on commit e385377

Please sign in to comment.