Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[JOSS review assistance] Tutorials - general feedback #76

Closed
4 tasks done
williamhobbs opened this issue Sep 21, 2023 · 1 comment
Closed
4 tasks done

[JOSS review assistance] Tutorials - general feedback #76

williamhobbs opened this issue Sep 21, 2023 · 1 comment

Comments

@williamhobbs
Copy link

williamhobbs commented Sep 21, 2023

Here are some of my initial thoughts about the tutorials in general:

  • a markdown file summarizing each of the tutorials and/or suggesting an order in which a user should work through them would be helpful. I see that there is a bit more info in https://pvops.readthedocs.io/en/latest/pages/examples.html. If the readthedocs example page is the best place to start, that should be linked in the README.md when referencing the examples directory. E.g., "Refer to the examples directory, following the guide at https://pvops.readthedocs.io/en/latest/pages/examples.html, for a full run-through of the available functionality."
  • https://pvops.readthedocs.io/en/latest/pages/examples.html calls these "examples" instead of "tutorials" - I would suggest consistent terminology.
  • Incomplete abbreviations page in docs: I noticed that https://pvops.readthedocs.io/en/latest/pages/abbreviations.html is mostly incomplete. This came up when I was trying to find more context for the Timeseries AIT Tutorial.
  • In general, more text in the tutorials to give context would be helpful. Perhaps this could be done by making setting up a fictional solar plant that all of the tutorials and example data would be based on. Give it a fake name, say where it is located, how big it is, what assets it has, etc. Talk about how it has a maintenance team that keeps written maintenance logs (show an example subset of a log file), and how there is there is a weather station and power meter with measurements logged to a data historian, etc. Then describe the tasks (real-world business needs/questions) that a performance engineer (the user going through the tutorials) will be trying to complete. In the process, reference all of the example data files that will be used in the tutorials.
@kbonney
Copy link
Collaborator

kbonney commented Oct 24, 2023

Addressed by #85 and some previous PRs.

  • Added a link in the README to direct users to tutorials
  • changed examples to tutorials for consistency
  • Updated abbreviations. I am sure more could be added here, so if you have anything in particular you think is useful feel free to mention

@kbonney kbonney closed this as completed Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants