search

TheIOFoundation / ProjectLockdown

Project Lockdown (an initiative from The IO Foundation) is a civic tech, interactive platform providing an overview of the state of Human and Digital Rights around the globe. It evaluates policies obtained from official sources that may impact their observance. It provides, among other tools, a layered map interface that allows for a visual representation of the policies adopted, assisting a broad range of stakeholders in understanding the global state of their Rights. This empowers them to become active agents of global change.
https://ProjectLockdown.world
GNU General Public License v3.0
36 stars 14 forks source link

[ADM] Enhance Stoplight docs to get DSL out of "construction" state #156

Open jeff-knurek opened 3 years ago

jeff-knurek commented 3 years ago

logo

What to document

https://theiofoundation.stoplight.io/docs/projectlockdown/API/Reference/Project-Lockdown.v1.json/components/schemas/DataSetLayer

As a child of the Environment object, the DSL schema definition is critical for all development.

Objectives

Ideally all models in the Stoplight documentation should be beyond the "construction" status and either "eye" or "complete", but the process is subjective, and so each model needs it's own attention.

Extra information

non-required attributes can be skipped

Related Issues

ColisaNo195 commented 3 years ago

I went through DSL documentation today. A few inquiries:

  1. Many entries missing explanations are "Name" and "Description", which are rather self-explanatory. We can add what kind of description we expect later on. Other missing documentations are mainly from object definitions under Model, I can check and update those.
  2. In Model/Tag, "synonyms" is defined as an array of reference to Tag, resulting in "synonyms" infinitely expand in the displayed documentation. Confirming whether this is intentional design of Tag.
  3. Based on my knowledge of our v1.0 design, certain objects should be enum than string. Do we have an existing stoplight page for enum definition? I haven't seen an option on stoplight to mark an object as enum, but we can add that info in documentation.