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.

Sign up for GitHub

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

Jump to bottom

Update Documentation in User's Guide #259

Merged
merged 32 commits into from
Dec 10, 2020
Merged

Update Documentation in User's Guide #259

merged 32 commits into from
Dec 10, 2020

Conversation

marcelofcastro
Copy link
Member

This PR tries to include every piece of documentation we have to be inside the library, within user's guide.

@marcelofcastro marcelofcastro added this to the 2.0.0 milestone Dec 5, 2020
@marcelofcastro marcelofcastro self-assigned this Dec 5, 2020
@marcelofcastro marcelofcastro linked an issue Dec 5, 2020 that may be closed by this pull request
Update contact details for 2.0.0 release #179
Closed
@dietmarw
Copy link
Member

dietmarw commented Dec 7, 2020

I've added some clean up. Mind only your table should be put under "revisions" any other information should stay in "info". There are also still occurrences of email addresses for contact that need to be updated.

@dietmarw
Copy link
Member

dietmarw commented Dec 7, 2020

One thing that is missing is that we should probably make use of the domain openipsl.org also in the User's Guide and top level package documentation.

@dietmarw
Copy link
Member

dietmarw commented Dec 7, 2020

Would it be a good idea to sort the publications by year and replace all those "links" by doi links?

@marcelofcastro
Copy link
Member Author

I've added some clean up. Mind only your table should be put under "revisions" any other information should stay in "info". There are also still occurrences of email addresses for contact that need to be updated.

Yeah, I know that. I might have forgot about one or two. I will check that now.

@marcelofcastro
Copy link
Member Author

Would it be a good idea to sort the publications by year and replace all those "links" by doi links?

maybe when we have the entire list updated for 2.0

dietmarw
dietmarw reviewed Dec 9, 2020
View reviewed changes
OpenIPSL/UsersGuide/package.mo
@@ -9,6 +9,7 @@ The <b>Open-Instance Power System Library - OpenIPSL</b> contains many power sys
</p>
<p>
This is a very short <b>User's Guide</b> that will try to help users to get familiar with the library providing general information about the <b>OpenIPSL</b>.
More information about the library can be found in this <a href=\"https://openipsl.readthedocs.io/en/latest/\">website</a> dedicated to the OpenIPSL organization.
</p>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you got the wrong address here. readthedocs should not appear anywhere. The content should actually be removed. It is openipsl.org that is the correct address.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this what you meant?

dietmarw
dietmarw reviewed Dec 9, 2020
View reviewed changes
OpenIPSL/package.mo Outdated
@@ -25,6 +25,8 @@ If you are looking for an introduction to the library, have especially a look at
<ul>
<li><a href=\"modelica://OpenIPSL.UsersGuide\">User's Guide</a>
and all its dependencies for general information about the library.</li>
<li><a href=\"https://openipsl.readthedocs.io/en/latest/\">openipsl.org</a>,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same problem here.

marcelofcastro
marcelofcastro commented Dec 9, 2020
View reviewed changes
OpenIPSL/package.mo Outdated Show resolved Hide resolved
dietmarw
dietmarw approved these changes Dec 9, 2020
View reviewed changes
Copy link
Member

@dietmarw dietmarw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are still some formulations in the User's Guide that I would like to go through but that can wait for the final release. Good enough for now.

dietmarw
dietmarw requested changes Dec 9, 2020
View reviewed changes
Copy link
Member

@dietmarw dietmarw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot one thing. This pull request should also remove all the now superfluous sphinx documentation files that are still present.

@marcelofcastro
Copy link
Member Author

@dietmarw do you want to keep something or do you just want to remove the docs folder (I don't remember if that's the folder that only contains the website stuff)?

marcelofcastro and others added 19 commits December 10, 2020 08:24
@marcelofcastro @dietmarw
add contact to shunt
86b6142
@marcelofcastro @dietmarw
adding contact to nonelec
64dbe67
@marcelofcastro @dietmarw
adding contacts to examples
72f20e1
@dietmarw
Improve the User's Guide slightly.
5d228dc
@dietmarw
Fixing the position of the information
58c161c
@dietmarw
Fixing syntax error in annotation name.
f5627fe
@dietmarw
Simply refer to version 33 for PSSE manuals.
105f050
@dietmarw
Removing extra <tr> elements
8a3baf2
@marcelofcastro @dietmarw
Update README.md
b96141e
@marcelofcastro @dietmarw
correct NYPA name
1304ccd
@marcelofcastro @dietmarw
rev for PSSE/TG
5dc68bb
@marcelofcastro @dietmarw
edit contacts for exciters
aa19e24
@marcelofcastro @dietmarw
contacts to pss
b16bc76
@marcelofcastro @dietmarw
contact in machines, wind, ssc
ec03e35
@marcelofcastro @dietmarw
adding reference to website
bb45ca4
@dietmarw @marcelofcastro
Fix link
48f3a8a 
Co-authored-by: Marcelo de C. Fernandes <decasm3@rpi.edu>
@dietmarw @marcelofcastro
fix link
4e4868f 
Co-authored-by: Marcelo de C. Fernandes <decasm3@rpi.edu>
@dietmarw
Fixing typos.
4a23538
@dietmarw
Remove old Sphinx files
d03c838 
These have now been converted into the UsersGuide also taking the updates from OpenIPSL#219 into account.
dietmarw
dietmarw approved these changes Dec 10, 2020
View reviewed changes
Copy link
Member

@dietmarw dietmarw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the PR needed to get rebased on latest branch any way I've now also removed the doc/ directory at the same time. It's good to merge now.

@dietmarw dietmarw mentioned this pull request Dec 10, 2020
Closed
dietmarw
dietmarw requested changes Dec 10, 2020
View reviewed changes
Copy link
Member

@dietmarw dietmarw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for going back and forth on this one. But I remembered that we are still missing the links to the verification data that is hosted on the dedicated repository. So that information should added to the verification section.

@marcelofcastro
Copy link
Member Author

The repository itself is private right now. When we make it public we can put the link to the repo. However, we already have the link to the website with the comparison results.

@dietmarw
Copy link
Member

Yes I was only talking about the website, the the source repository

@marcelofcastro
Copy link
Member Author

But I have already mentioned the website in the result verification page.

@marcelofcastro marcelofcastro merged commit 0f88fa6 into OpenIPSL:master Dec 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dietmarw dietmarw dietmarw approved these changes

Assignees

@marcelofcastro marcelofcastro

Labels
DOC
Projects
None yet
Milestone
2.0.0
Development

Successfully merging this pull request may close these issues.

Update contact details for 2.0.0 release
2 participants
@marcelofcastro @dietmarw