diff --git a/gitbook/tools/navtex/README.md b/gitbook/tools/navtex/README.md new file mode 100644 index 000000000..54e110969 --- /dev/null +++ b/gitbook/tools/navtex/README.md @@ -0,0 +1,57 @@ +--- +description: A brief one-line description of the tool. +--- + +# Navtex + +## URL + +https://example.com + +## Description + +\[\[ A full description of the tool, any background information needed to use it. What problem does it solve? Can you give an example use case? ]] + +## Cost + +* [x] Free +* [ ] Partially Free +* [ ] Paid + +\[\[Pricing or subscription information, if relevant.]] + +## Level of difficulty + +
1
+ +## Requirements + +\[\[Information on the requirement for using a tool, for instance, API key, e-mail address etc.]] + +## Limitations + +\[\[The limitations of each tool should be described. This is important for researchers if they want to decide whether they should invest the time to learn how to use a new tool.]] + +## Ethical Considerations + +\[\[The ethical considerations of each tool should be described.]] + +## Guides and articles + +\[\[Link to guides on this tool and to articles on research that was done with the help of this tool]] + +## Tool provider + +\[\[Name the tool provider (and potentially info on them)]] + +## Advertising Trackers + +* [x] This tool has not been checked for advertising trackers yet. +* [ ] This tool uses tracking cookies. Use with caution. +* [ ] This tool does not appear to use tracking cookies. + +| Page maintainer | +| -------------------------------------------------------------- | +| \[\[Your name here (optional) or "Bellingcat volunteer team"]] | +| | + diff --git a/gitbook/tools/navtex/SUMMARY.md b/gitbook/tools/navtex/SUMMARY.md new file mode 100644 index 000000000..938cc0353 --- /dev/null +++ b/gitbook/tools/navtex/SUMMARY.md @@ -0,0 +1,4 @@ +# Table of contents + +* [Navtex](README.md) +* [JSON](json.md) diff --git a/gitbook/tools/navtex/json.md b/gitbook/tools/navtex/json.md new file mode 100644 index 000000000..355bca69e --- /dev/null +++ b/gitbook/tools/navtex/json.md @@ -0,0 +1,40 @@ +--- +description: This is the JSON codeblock for this tool +--- + +# JSON + +{% code overflow="wrap" %} +```json +{ + "draft": true, + "name": "Navtex", + "description": "A brief one-line description of the tool.", + "url": "https://example.com", + "tags": [] +} +``` +{% endcode %} + +Keep the codeblock updated with accurate information. Only edit the **values** (words to the right of the `:` on each line, in dark blue font). Do not change the key names (left side, slightly light blue) or any of the other formatting. Every line should end in a comma except the last line. Every key and value should be enclosed in quotation marks. See below for an explanation of each line. + +## name, description (optional) + +If omitted, the name and description will be copied from the page title and page description of the main content. If present, the JSON values override the main content. + +## draft (optional) + +If set to `true`, this prevents this tool from being listed in relevant category pages. Useful if the tool does not yet have a url and description set. Omit or set to false to publish. + +## url + +A hyperlink directly to the tool, for quick-access from the category page. Be sure to use the secure (http**S**) version if possible. + +## tags + +This list of tags will determine which category pages the tool appears on. Tags should be lowercase with dashes between words and no spaces: e.g., "facial-recognition". Seperate tags with a comma `,`. + +If a tool is completely free to use, include the tag "free". + +If the tool is focused on one specific country (or a limited number of them), tag it with the name of the country as well as "international". +