diff options
| author | Georgios Andreadis <info@gandreadis.com> | 2019-12-20 11:37:25 +0100 |
|---|---|---|
| committer | Georgios Andreadis <info@gandreadis.com> | 2020-02-14 19:14:31 +0100 |
| commit | 773eaf770313fa245250e8e1661ee50444223c98 (patch) | |
| tree | 966541114f40a7ca11097d791b0d9e663e789a53 | |
| parent | b593268b50784964c672f8b5aaa857e9b9243634 (diff) | |
Create guidelines for documentation sections
| -rw-r--r-- | docs/architecture.md | 4 | ||||
| -rw-r--r-- | docs/models.md | 6 | ||||
| -rw-r--r-- | docs/run.md | 2 | ||||
| -rw-r--r-- | odcsim/docs/build.md | 4 |
4 files changed, 14 insertions, 2 deletions
diff --git a/docs/architecture.md b/docs/architecture.md index d26a8749..a854bf6d 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -1,4 +1,8 @@ # 2. Architecture Overview +**TODO: What are the main components (odcsim-core, odcsim-engine, opendc-core, opendc-format, opendc-testkit, opendc-workflows, I assume)? Short description of each in a bullet list (or even a schema drawing, if you have the time). Why this division?** + +**TODO: One section per component, explaining what their responsibility is and what other modules they talk to. In what kind of scenarios do you as OpenDC developer need to touch/change them?** + --- [< Previous](setup.md) | [Next >](models.md) diff --git a/docs/models.md b/docs/models.md index 447f50b7..fab8cdcf 100644 --- a/docs/models.md +++ b/docs/models.md @@ -1,4 +1,8 @@ -# 2. Architecture Overview +# 3. Pre-built Models + +**TODO: Introduction: we have a library of pre-built models to make things easier for you, here we present them etc.** + +**Per model in the architecture (corresponding with the architecture document), give the list of models we include out of the box. Explain what it does (and if applicable, what it doesn't do).** --- [< Previous](architecture.md) | [Next >](models.md) diff --git a/docs/run.md b/docs/run.md index c6e26bc7..d3143d96 100644 --- a/docs/run.md +++ b/docs/run.md @@ -1,4 +1,6 @@ # 4. Running a Model +**TODO: Not sure yet what's useful to include here. Maybe give an example of how to run one of the pre-builts?** + --- [< Previous](models.md) | [Next >](build.md) diff --git a/odcsim/docs/build.md b/odcsim/docs/build.md index 761fb71a..21983355 100644 --- a/odcsim/docs/build.md +++ b/odcsim/docs/build.md @@ -1,4 +1,6 @@ -# Building Your Own Model +# 5. Building Your Own Model + +**TODO: What goes into building a model? Where do you start? Can be quite technical (what gradle scripts do I need to make, what directory structure, ...), maybe center around a simple example scenario?** --- [< Previous](run.md) |