Skip to content

Corrected documentation for contact_person. #989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Corrected documentation for contact_person. #989

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 27 additions & 23 deletions docs/howto/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,26 +221,30 @@ contact_person
^^^^^^^^^^^^^^

This is only used by *make_metadata.py* when it constructs the metadata for
the service described by the configuration file.
This is where you describe who can be contacted if questions arise
about the service or if support is needed. The possible types are according to
the standard **technical**, **support**, **administrative**, **billing**
and **other**.::
the service described by the configuration file. This is where you describe
who can be contacted if questions arise about the service or if support is
needed.

Note that `contact_type` is required for a valid schema. The possible types
are according to the standard **technical**, **support**, **administrative**,
**billing** and **other**::

contact_person: [
{
"givenname": "Derek",
"surname": "Jeter",
"given_name": "Derek",
"sur_name": "Jeter",
"company": "Example Co.",
"mail": ["[email protected]"],
"type": "technical",
"email_address": ["[email protected]"],
"telephone_number": ["123-456-789", "+1 234 567 89"]
"contact_type": "technical",
},
{
"givenname": "Joe",
"surname": "Girardi",
"given_name": "Joe",
"sur_name": "Girardi",
"company": "Example Co.",
"mail": "[email protected]",
"type": "administrative",
"email_address": ["[email protected]", "[email protected]"]
"telephone_number": ["987-654-321"]
"contact_type": "administrative",
},
]

Expand Down Expand Up @@ -1481,11 +1485,11 @@ We start with a simple but fairly complete Service provider configuration::
}
"contact_person": [
{
"givenname": "Roland",
"surname": "Hedberg",
"phone": "+46 90510",
"mail": "[email protected]",
"type": "technical",
"given_name": "Roland",
"sur_name": "Hedberg",
"telephone_number": ["+46 90510"],
"email_address": ["[email protected]"],
"contact_type": "technical",
},
]
}
Expand Down Expand Up @@ -1539,11 +1543,11 @@ A slightly more complex configuration::
}
"contact_person": [
{
"givenname": "Roland",
"surname": "Hedberg",
"phone": "+46 90510",
"mail": "[email protected]",
"type": "technical",
"given_name": "Roland",
"sur_name": "Hedberg",
"telephone_number": ["+46 90510"],
"email_address": ["[email protected]"],
"contact_type": "technical",
},
]
}
Expand Down