Skip to content

Commit 4b2f42c

Browse files
committed
Update about dev tool.
1 parent 50e4971 commit 4b2f42c

File tree

1 file changed

+11
-0
lines changed
  • documentation/docs/developer-guide

1 file changed

+11
-0
lines changed

documentation/docs/developer-guide/adrs.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,3 +158,14 @@ Another downside is that ``Yaml`` is less secure than ``json`` due to its flexib
158158
Service maintainers are expected to keep these configuration/schema files in a secured isolated environment<br>
159159
and we implement extra safety/validation layers of configuration/schema files in the relevant places.<br>
160160
For example, ``yaml`` must be loaded with ``safe_load`` method.
161+
162+
### Supporting Tool for Transition
163+
We were already using ``json`` in our production environment so to make the transition smoother,<br>
164+
we implemented a tool that can translate ``json`` to ``yaml`` easily.
165+
166+
```bash
167+
scicat_json_to_yaml --input-file PATH/TO/THE/JSON/FILE
168+
```
169+
170+
It can be used for any configuration or schema files.
171+

0 commit comments

Comments
 (0)