Difference between revisions of "Main Page"

From City Data Model Project Collaboratory
Jump to navigation Jump to search
Line 15: Line 15:
 
See something missing?
 
See something missing?
 
Propose a new class: {{#forminput:form=Proposed_Class_Form|button text=submit}}
 
Propose a new class: {{#forminput:form=Proposed_Class_Form|button text=submit}}
 +
 +
== The Workflow ==
 +
Here's a high-level overview of the process that we follow when a new term is proposed for the City Data Model:
 +
 +
@startuml
 +
 +
title Proposing a New Term for the CDM
 +
 +
start
 +
:create proposal;
 +
 +
:suggest appropriate ontology;
 +
    if (new ontology?) then (yes)
 +
        :Propose New Ontology;
 +
    else(no)
 +
    endif;
 +
:specify description;
 +
 +
:specify definition (UML or DL);
 +
 +
:specify use case(s);
 +
 +
:publish for review;
 +
:users review proposal;
 +
 +
if (requirement is met by an existing class or property?) then (yes)
 +
    :indicate redundancy in comments;
 +
    if (community in agreement?) then (yes)
 +
        :close proposal;
 +
        stop
 +
    else(no)
 +
        while (undecided) is (yes)
 +
            :discuss;
 +
            :editorial review;
 +
        endwhile(no);
 +
    endif;
 +
    else(no)
 +
    endif;
 +
        :users propose revisions/additions to definition (properties, constraints), motivating scenarios;
 +
       
 +
            if (owner revise?) then (yes)
 +
                :comment resolved;
 +
            else(no)
 +
                :comment left unresolved;
 +
            endif;
 +
   
 +
        :editorial review;
 +
        :editorial comments to author;
 +
        :author revisions;
 +
        :final review;
 +
        :publication of final version (change protected);
 +
 +
stop
 +
 +
@enduml
 +
 +
 +
<b>Note:</b> this diagram was drawn using [[http://plantuml.com|PlantUML]]. PlantUML is a handy tool that allows you to create UML (and non-UML) diagrams using simple text descriptions. It's supported by this Wiki to help you contribute more effectively.
  
 
== To Do ==
 
== To Do ==

Revision as of 18:57, 10 October 2019

Welcome to the City Data Model Collaboration Wiki!

We have created this website to enable stakeholders and related standards groups to:

  • Review the contents of the City Data Model.
  • Propose new classes or properties
  • Comment on existing classes
  • Comment on proposed classes
  • Suggest changes and additions

How it works

Anyone with an account can comment on proposed or existing terms, and even propose their own.

Getting started

Want to contribute? Log-in or create an account!

See something missing?

Propose a new class:


The Workflow

Here's a high-level overview of the process that we follow when a new term is proposed for the City Data Model:

@startuml

title Proposing a New Term for the CDM

start

create proposal;
suggest appropriate ontology;
   if (new ontology?) then (yes)
       :Propose New Ontology;
   else(no)
   endif;
specify description;
specify definition (UML or DL);
specify use case(s);
publish for review;
users review proposal;

if (requirement is met by an existing class or property?) then (yes)

   :indicate redundancy in comments;
   if (community in agreement?) then (yes)
       :close proposal;
       stop
   else(no)
       while (undecided) is (yes)
           :discuss;
           :editorial review;
       endwhile(no);
   endif;
   else(no)
   endif;
       :users propose revisions/additions to definition (properties, constraints), motivating scenarios;
       
           if (owner revise?) then (yes)
               :comment resolved;
           else(no)
               :comment left unresolved;
           endif;
   
       :editorial review;
       :editorial comments to author;
       :author revisions;
       :final review;
       :publication of final version (change protected);

stop

@enduml


Note: this diagram was drawn using [[1]]. PlantUML is a handy tool that allows you to create UML (and non-UML) diagrams using simple text descriptions. It's supported by this Wiki to help you contribute more effectively.

To Do

Link to Github
Link to publications (reports, papers, ...)
Add summary of classes / class definitions for each city-level ontology
Set permissions for different user types