Commit c3eb7595 authored by EyaChafroud2's avatar EyaChafroud2 Committed by GitHub

Update json-guidelines.md

parent c1fd2747
...@@ -59,51 +59,54 @@ A success case without an article is a reference, a reference with an article is ...@@ -59,51 +59,54 @@ A success case without an article is a reference, a reference with an article is
Do not duplicate success cases in references Do not duplicate success cases in references
Before saving a JSON file, check it with jsonlint (https://jsonlint.com/). Before saving a JSON file, check it with jsonlint (https://jsonlint.com/).
Classification of values  Classification of values 
Classification of values 
For industry types (type) : For industry types (type) :
Company; * Company;
NGO; * NGO;
Government; * Government;
Individual; * Individual;
Other. * Other.
For license types: use "licence keywords" from Github (https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)  For license types: use "licence keywords" from Github (https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) 
afl-3.0 * afl-3.0
apache-2.0 * apache-2.0
... * ...
List of validated sources for financial data: List of validated sources for financial data:
verif.com (FR);  * verif.com (FR); 
societe.com (FR); * societe.com (FR);
bundesanzeiger.de '(DE); * bundesanzeiger.de '(DE);
find-and-update.company-information.service.gov.uk (GB). * find-and-update.company-information.service.gov.uk (GB).
Possible solution_category  Possible solution_category 
Storage and database  * Storage and database 
Compute virtualisation  * Compute virtualisation 
Desktop virtualisation * Desktop virtualisation
vRan  * vRan 
Operation management  * Operation management 
Service lifecycle automation * Service lifecycle automation
Networking * Networking
Identity * Identity
Cybersecurity * Cybersecurity
Application * Application
Workspace * Workspace
Developer environment  * Developer environment 
Developer API * Developer API
Communication  * Communication 
IoT and industrial  * IoT and industrial 
Big Data Hub * Big Data Hub
Server * Server
Switch * Switch
Router * Router
Rack * Rack
Cooling * Cooling
CPU * CPU
Radio * Radio
ISO Standards * ISO Standards
Country codes: https://www.ncbi.nlm.nih.gov/books/NBK7249/ Country codes: https://www.ncbi.nlm.nih.gov/books/NBK7249/
Language codes: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes Language codes: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
...@@ -116,17 +119,17 @@ Currency codes : https://fr.iban.com/currency-code ...@@ -116,17 +119,17 @@ Currency codes : https://fr.iban.com/currency-code
Syntax Syntax
telephone contact telephone contact
| |phone_contact | | |phone_contact |
| ------------- |:-------------:| -----:| | ------------- | -----:|
| Format | "+", followed by the country's international telephone code, followed by " ", followed by the phone number in the country, all between quotation marks.| | Format | "+", followed by the country's international telephone code, followed by " ", followed by the phone number in the country, all between quotation marks.|
| Example | "+33 629 02 44 25" | Example | "+33 629 02 44 25"
|Guide|[List of international telephone codes by country](https://fr.wikipedia.org/wiki/Liste_des_indicatifs_t%C3%A9l%C3%A9phoniques_internationaux_par_pays) |Guide|[List of international telephone codes by country](https://fr.wikipedia.org/wiki/Liste_des_indicatifs_t%C3%A9l%C3%A9phoniques_internationaux_par_pays)
[UIT-T E.123](https://www.itu.int/rec/dologin_pub.asp?lang=e&id=T-REC-E.123-198811-S!!PDF-F&type=items) [UIT-T E.123](https://www.itu.int/rec/dologin_pub.asp?lang=e&id=T-REC-E.123-198811-S!!PDF-F&type=items)
GPS coordinates GPS coordinates
| |coordinate_list | | |coordinate_list |
| ------------- |:-------------:| -----:| | ------------- |-----:|
| Format | Geographic coordinates in square brackets, without quotation marks inside.| | Format | Geographic coordinates in square brackets, without quotation marks inside.|
| Example |[50.64449017329376, 3.077437939381641] | Example |[50.64449017329376, 3.077437939381641]
|Guide| |Guide|
...@@ -136,28 +139,28 @@ Right click on the icon designating the location of the company in google maps ...@@ -136,28 +139,28 @@ Right click on the icon designating the location of the company in google maps
Headquarters location Headquarters location
| |country | | |country |
| ------------- |:-------------:| -----:| | ------------- |-----:|
| Format | ISO country code in upper case between quotation marks | | Format | ISO country code in upper case between quotation marks |
| Example | "FR" ou "LU" | | Example | "FR" ou "LU" |
|Guide |[ISO country codes list](http://www.ncbi.nlm.nih.gov/books/NBK7249/)| |Guide |[ISO country codes list](http://www.ncbi.nlm.nih.gov/books/NBK7249/)|
Headquarters location Headquarters location
| |country | | |country |
| ------------- |:-------------:| -----:| | ------------- |-----:|
| Format | ISO country code in upper case between quotation marks | | Format | ISO country code in upper case between quotation marks |
| Example | "FR" ou "LU" | | Example | "FR" ou "LU" |
|Guide |[ISO country codes list](http://www.ncbi.nlm.nih.gov/books/NBK7249/)| |Guide |[ISO country codes list](http://www.ncbi.nlm.nih.gov/books/NBK7249/)|
Company performance indicators Company performance indicators
| |KPI | | |KPI |
| ------------- |:-------------:| -----:| | ------------- |-----:|
| Format | Value followed by a space, followed by currency code of the country in upper case, all between quotation marks | | Format | Value followed by a space, followed by currency code of the country in upper case, all between quotation marks |
| Example | "1000 EUR" | | Example | "1000 EUR" |
|Guide |[List of ISO currency codes by country](https://fr.iban.com/currency-codes)| |Guide |[List of ISO currency codes by country](https://fr.iban.com/currency-codes)|
Categories list Categories list
| |category_list | | |category_list |
| ------------- |:-------------:| -----:| | ------------- |-----:|
| Format | A category in quotation marks, followed by a comma, followed by another category or more, all between brackets. | | Format | A category in quotation marks, followed by a comma, followed by another category or more, all between brackets. |
| Example | ["Cybersecurity", "Application"] | | Example | ["Cybersecurity", "Application"] |
| Guide | See possible values for solution_category. A solution can have one or more categories | | Guide | See possible values for solution_category. A solution can have one or more categories |
...@@ -165,7 +168,7 @@ Categories list ...@@ -165,7 +168,7 @@ Categories list
License list License list
| |license_list | | |license_list |
| ------------- |:-------------:| -----:| | ------------- |-----:|
| Format | One license between quotation marks, followed by a comma, followed by one or more licenses, all in square brackets | | Format | One license between quotation marks, followed by a comma, followed by one or more licenses, all in square brackets |
| Example | ["afl-3.0", "apache-2.0"] | | Example | ["afl-3.0", "apache-2.0"] |
| Guide | [License Keyword of Github](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) | | Guide | [License Keyword of Github](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) |
...@@ -173,7 +176,7 @@ License list ...@@ -173,7 +176,7 @@ License list
Solution source code (for solutions that publish their source code) Solution source code (for solutions that publish their source code)
| |source_code_download | | |source_code_download |
| ------------- |:-------------:| -----:| | ------------- |-----:|
| Format | Github repository URL | | Format | Github repository URL |
| Example | "[https://lab.nexedi.com/nexedi/erp5.git](https:/lab.nexedi.com/nexedi/erp5.git)" | Example | "[https://lab.nexedi.com/nexedi/erp5.git](https:/lab.nexedi.com/nexedi/erp5.git)"
|Guide| Search source codes on [Github](https://github.com/) | |Guide| Search source codes on [Github](https://github.com/) |
...@@ -181,21 +184,21 @@ Solution source code (for solutions that publish their source code) ...@@ -181,21 +184,21 @@ Solution source code (for solutions that publish their source code)
Satistics of source code (for open source solutions) Satistics of source code (for open source solutions)
| |source_code_profile | | |source_code_profile |
| ------------- |:-------------:| -----:| | ------------- |-----:|
| Format | Openhub repository URL | | Format | Openhub repository URL |
| Example | "[https://www.openhub.net/p/erp5](https:/www.openhub.net/p/erp5)" | Example | "[https://www.openhub.net/p/erp5](https:/www.openhub.net/p/erp5)"
|Guide| Search source code profile on [Openhub](https://www.openhub.net/) | |Guide| Search source code profile on [Openhub](https://www.openhub.net/) |
Free Libre Open Source software Free Libre Open Source software
| | FLOSS software | | | FLOSS software |
| ------------- |:-------------:| -----:| | ------------- |-----:|
| Format | Possible values includes true or false must not be put between quotation marks and must not include upper case letters | | Format | Possible values includes true or false must not be put between quotation marks and must not include upper case letters |
| Example | true or false | Example | true or false
|Guide| Research on the company's website if the commercial support section is available | |Guide| Research on the company's website if the commercial support section is available |
Commercial support open source version, if it exists Commercial support open source version, if it exists
| | commercial_support_open_source_version | | | commercial_support_open_source_version |
| ------------- |:-------------:| -----:| | ------------- | -----:|
| Format | Possible values includes true or false must not be put between quotation marks and must not include upper case letters | | Format | Possible values includes true or false must not be put between quotation marks and must not include upper case letters |
| Example | true or false | | Example | true or false |
|Guide| Research on the company's website if the commercial support section is available | |Guide| Research on the company's website if the commercial support section is available |
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment