Skip to content

Make documentation more layman-friendly #191

Description

@KoenvanB

Context

Using the pyETM Excel workflow to create scenarios and retrieve scenario outcomes.

Current shortcoming

A lot of terms on the Excel workflow documentation page are unfamiliar to me or require additional explanation:

EXPORT_CONFIG
What is meant by 'exporting'? Does that mean the results are inserted in the same Excel that contains the MAIN, SLIDER_SETTINGS etc tabs?

MAIN

  • session: I don't know the distinction between a session ID and a scenario ID (but might be a moot point considering the ongoing Technical Infrastructure project)
  • copy_from: what does this do? Does this create a copy of an existing scenario? If so, how does that relate to the SLIDER_SETTINGS for this scenario if I provide those as well?
  • private: if TRUE, does this mean someone else can't open my scenario even with the link?

Proposed enhancement

Include links to pages (e.g. docs or pyETM docs) that explain some of the concepts above. Or add an explanation on the spot.

Success criteria

The answers to the questions above are readily retrievable from the Excel docs page.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions