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

Documentation Scada and CMT #315

Closed
JoranAngevaare opened this issue Dec 15, 2020 · 4 comments · Fixed by #481
Closed

Documentation Scada and CMT #315

JoranAngevaare opened this issue Dec 15, 2020 · 4 comments · Fixed by #481
Assignees
Labels
documentation Something should be addressed in the docs help wanted Extra attention is needed

Comments

@JoranAngevaare
Copy link
Contributor

Straxen would benefit from more elaborate documentation. Lately some fantastic features were added.

It would be good if we can provide more elaborate documentation of do's and don't for:

  1. the OnlineMonitor (I, @jorana can work on that)
  2. the ScadaInterface (perhaps @WenzDaniel )
  3. CMT (perhas @ahiguera-mx)

Some of these things might be better suitable for this than others as it has to be written in such a way so as not to expose any xenon-secrets. Nevertheless, explaining structures can be very helpfull for other people to be pointed to.

The threshold for writing documentation should be as low as possible. Here is an example of documentation I just on the gridfs interface: 889572f

@JoranAngevaare JoranAngevaare added help wanted Extra attention is needed documentation Something should be addressed in the docs labels Dec 15, 2020
@JoranAngevaare JoranAngevaare self-assigned this Dec 15, 2020
@JoranAngevaare JoranAngevaare linked a pull request May 7, 2021 that will close this issue
@WenzDaniel
Copy link
Collaborator

I think we should still add SCADA and CMT is not it? At least it is still on my agenda.

@JoranAngevaare
Copy link
Contributor Author

yes, this was one of the automatic closing actions of github which was unintended

@JoranAngevaare JoranAngevaare changed the title Documentation of OnlineMonitor Scada and CMT Documentation Scada and CMT May 13, 2021
@ahiguera-mx
Copy link
Contributor

I can work on the CMT documentation

@JoranAngevaare
Copy link
Contributor Author

Fixed, thanks guys!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something should be addressed in the docs help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants