Skip to content

Documentation: Duplicate (almost) documentation on observations #1087

@hkershaw-brown

Description

@hkershaw-brown

What's the issue?

📚 Please describe the problem you’ve noticed in the documentation.
Noticed this while searching the docs for representativeness error:

These two pages have (almost) duplicate content.

https://docs.dart.ucar.edu/en/latest/guide/creating-obs-seq-real.html
https://docs.dart.ucar.edu/en/latest/observations/obs_converters/README.html

Also:
"There are currently about 10 other observation sources and types which we are in the process of collecting information and conversion programs for and which will eventually be added to this directory"
Really?

Where did you find the issue?

Provide the location(s) of the issue:

What needs to be fixed?

Share what’s incorrect, unclear, missing, or outdated.

Duplicated docs.
Possibly outdated (10 obs converters in the works?)

Also https://docs.dart.ucar.edu/en/latest/observations/obs_converters/README.html#data-sources-and-formats has random line from the table in the text.

Suggestions for improvement

If you have any ideas to fix or generally improve this documentation, please share them.

"Creating an obs_seq file from real observations" doesn't seem to actually cover creating observation sequences, for example that you run a converter for each type of observation, then join the observation sequences together for your experiments. "It may be desirable to post-process multiple observation sequence files"
It seems a bit blurry to me about what is the description of creating an observation converter and adding a new observation to dart, and obs seqeunces for real obs.

https://docs.dart.ucar.edu/en/latest/guide/adding-support-new-type.html
is pretty short, and it seems like the step of adding a new observation type, is not that clear. New converter vs. new type.

Anything else we should know?

Include any other relevant details, such as references, screenshots, or related discussions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions