powsybl / powsybl.github.io Goto Github PK

For instance, in the Load page, the characteristics table is not displayed correctly on smartphone

Describe the current behavior

Security analysis page is not up-to-date, at least concerning the contingencies input, it is said

At the moment, the only way to provide contingencies is to use the Contingency Domain Specific Language, written in Groovy.

Describe the expected behavior

Contingencies can be provided through a JSON file

Describe the steps

No response

Environment

No response

Relevant Log Output

No response

Extra Information

No response

• Do you want to request a feature or report a bug?
  Feature

• What is the current behavior?
  If we navigate to a too deep page (depth > 3), there is no more active item selected in the side bare

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem
  Navigate to the CGMES or UCTE page.

• What is the expected behavior?
  We should select (add active class) the closest entry in the menu or limit the depth of the pages. This should be problematic if we decide to split a page into several with next/previous buttons.

• What is the motivation / use case for changing the behavior?
  Make the navigation easier

• Please tell us about your environment:

  • PowSyBl Version: ...
  • OS Version: ...

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)

Describe the current behavior

The documentation is lacking a lot of links that thus point towards the current page.
They are displayed as red links on the website.
It is the case on this page.
This page also contains a dead link when clicking on documentation in the Slow implementation section.

This issue was only created not to lose the pages were I found errors.

Describe the expected behavior

No response

Describe the steps

No response

Environment

No response

Relevant Log Output

No response

Extra Information

No response

We have to add links to every component or sub-component in all IIDM pages to reflect the java model. For instance, we should find links to the CurrentLimits in all branches pages (Lines, transformers...), links to the reactive limits in generator and VSC pages...

Is this the problem https://desk.draw.io/support/solutions/articles/16000042487-why-does-the-text-of-svg-export-sometimes-not-display-correctly-in-ie-and-some-svg-editors- ?

Originally posted by @jonenst in #106 (comment)

• Do you want to request a feature or report a bug?
  Feature

• What is the current behavior?
  The sidebar implementation is very dirty: we use a fixed menu and fixed category in the config.yml.

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

• What is the expected behavior?
  The meta information should be put in the front-matter of each page.

• What is the motivation / use case for changing the behavior?
  Simplify the config.yml file and ease the maintaining of sidebar.yml

• Please tell us about your environment:

  • PowSyBl Version: ...
  • OS Version: ...

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)

• Do you want to request a feature or report a bug?
  Feature

• What is the current behavior?
  The table are not always readable: the column width fits to the content and sometimes is really closed to the text.

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

• What is the expected behavior?
  The table should be more readable: we have to customize the CSS for the tables.

• What is the motivation / use case for changing the behavior?

• Please tell us about your environment:

  • PowSyBl Version: ...
  • OS Version: ...

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)

• Do you want to request a feature or report a bug?

feature

• What is the current behavior?

There is a documentation page that lists all the modules.

https://www.powsybl.org/docs/configuration/modules/

But it does not relate the modules to the actual code base.

• What is the motivation / use case for changing the behavior?

If you could link the module in the documentation to the source code, it would be easier for new comers to explore the topics by themselves!

• Do you want to request a feature or report a bug?
  feature

• What is the current behavior?
  It's hard to understand the docs because we can't see the global structure of the pages

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem
  go to https://www.powsybl.org/docs/ and try to get a global vision of the structure of the documentation

• What is the expected behavior?
  You can understand how things are structured, how they relate to each other, what you should read before something else, etc.

• What is the motivation / use case for changing the behavior?
  better user documentation

• Do you want to request a feature or report a bug?
  Bug

• What is the current behavior?
  If a user follow a todo link, the sidebar is closed because the todo.md page has no category.

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

• What is the expected behavior?
  If we create an empty page, using the todo layout (like for loadflow, the menu is open and the corresponding item is selected

• What is the motivation / use case for changing the behavior?
  Make the navigation easier

• Please tell us about your environment:

  • PowSyBl Version: ...
  • OS Version: ...

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)

• Do you want to request a feature or report a bug?
  bug

• What is the current behavior?
  
  horizontal scrolling at 377 and below pixel width. Unfortunately, a lot of devices have a viewport of 360-375 px width
  https://mediag.com/blog/popular-screen-resolutions-designing-for-all/

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem
  there is horizontal scroll

• What is the expected behavior?
  no horizontal scroll

• What is the motivation / use case for changing the behavior?
  aesthetics

• Do you want to request a feature or report a bug?
  Feature

• What is the current behavior?
  The footer is sometimes in the middle of the screen if the content of the page is small.

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem
  Navigate to the user stories page

• What is the expected behavior?
  For small pages, the footer should be fixed to the bottom of the page.

• What is the motivation / use case for changing the behavior?

• Please tell us about your environment:

  • PowSyBl Version: ...
  • OS Version: ...

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)

• Do you want to request a feature or report a bug?
  Bug

• What is the current behavior?
  Some fields are required in iidm xsd but optional in the doc

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem
  One example :
  http://www.powsybl.org/docs/iidm/model/substation.html
  The country is optional here.

In the xsd:
<xs:attribute name="country" use="required" type="iidm:nonEmptyString"/>

• What is the expected behavior?
  Consistency

Add a search mechanism to the website to help people to find information. Several solutions exist:

• Algolia
• Google
• Lunr.js

• Do you want to request a feature or report a bug?
  Feature

• What is the current behavior?
  There is no documentation to explain all the layout/positioning algorithms supported in single-line-diagram. We need a functional description to explain both voltage level layout algorithms and substation layout algorithms.

• What is the motivation / use case for changing the behavior?
  Answer on the website to the questions asked by users of single-line-diagram (by email but also on spectrum)

• Other information
  Note that the existing documentation in single-line-diagram repo should help writing that documentation

• Do you want to request a feature or report a bug?
  Feature

• What is the current behavior?
  There is no documentation to explain the topology description supported in PowSyBl. We need a functional description, somewhere in the grid model description, and to rework the existing tutorial to follow the new format.

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

• What is the expected behavior?

• What is the motivation / use case for changing the behavior?
  Answer to the question of Zack, asked on spectrum: https://spectrum.chat/powsybl/questions/is-there-any-beginners-guides-on-how-to-use-powsybl~e254b24e-1bb7-4183-9baa-736fe7ccb6f4

• Please tell us about your environment:

  • PowSyBl Version: ...
  • OS Version: ...

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)

• Do you want to request a feature or report a bug?
  Feature

• What is the current behavior?
  The snippet are printed with a monospace font, but they are not really visible.

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

• What is the expected behavior?
  We should customize the CSS to have a better rendering of the piece of code.

• What is the motivation / use case for changing the behavior?

• Please tell us about your environment:

  • PowSyBl Version: ...
  • OS Version: ...

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)

• Do you want to request a feature or report a bug?
  Feature

• What is the current behavior?
  There is no documentation to explain all the layout parameters available in single-line-diagram. We need a short functional description for each of them, ideally with a svg illustrating the changes.

• What is the motivation / use case for changing the behavior?
  Help the users of single-line-diagram customizing the algorithm, and promote the new features! but that might also lead to a clean up (some old parameters seemed to be useless now)

• Other information
  Note that a link to that required page was already created in PR #161

• Do you want to request a feature or report a bug?
  Bug

• What is the current behavior?
  In some pages, we use equipments but `equipment has no plural form.

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

• What is the expected behavior?
  Have equipment everywhere but pay attention the mistake also exist in the contingency DSL

• What is the motivation / use case for changing the behavior?
  Improve the documentation

• Please tell us about your environment:

  • PowSyBl Version: ...
  • OS Version: ...

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)

Describe the current behavior

Grid model documentation page is missing some parts:

• TODO for "Validation level" subsection
• TODO for SVC description / sketch
• Empty "Going further" section

Describe the expected behavior

The missing parts should be completed (or the section removed).
Indeed the page will gain more attention as it's going to be referenced from other projects.

Describe the steps

No response

Environment

No response

Relevant Log Output

No response

Extra Information

No response

• Do you want to request a feature or report a bug?
  feature

• What is the current behavior?
  the documentation is always the latest version

• What is the expected behavior?
  You should be able to browse older releases documentations

The navigation bar is not fully responsible: the button are one above the others on smartphone.

• Do you want to request a feature or report a bug?
  Feature

• What is the current behavior?
  There is no tutorial to explain how to create a network from scratch. I think we can create a simple one based on the well known eurostag1-tutorial: we have the factory in the code, the XML in the resources and probably the schema of the network somewhere, so it doesn't require so much time.

We would have to create a second one (or a second chapter in this tutorial to create the same network in Node/Breaker topology). This issue is linked to #140

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

• What is the expected behavior?

• What is the motivation / use case for changing the behavior?
  Answer to the answer of Zach: https://spectrum.chat/powsybl/questions/is-there-any-beginners-guides-on-how-to-use-powsybl~e254b24e-1bb7-4183-9baa-736fe7ccb6f4

• Please tell us about your environment:

  • PowSyBl Version: ...
  • OS Version: ...

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)

• Do you want to request a feature or report a bug?

The current version of the file "ROADMAP.md" is too old (from 2019).

• What is the current behavior?

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

• What is the expected behavior?

Please put in the file what you have planned to develop in 2020 (quarter or month details). I am going to make this exercice for IIDM, CGMES and model integration.

• What is the motivation / use case for changing the behavior?

• Please tell us about your environment:

  • PowSyBl Version: ...
  • OS Version: ...

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)

• Do you want to request a feature or report a bug?
  bug

• What is the current behavior?
  it's hard to know where a link will take you to. When browsing the docs, you decide depending on the link if you want to visit it or not. Since all links are named "documentation", you have to hover your mouse on it to know where it goes. On mobile it's even worse..

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem
  https://www.powsybl.org/docs/ has 3 links with the text "documentation". There are more of them in other pages:

./docs/index.md:Read this [documentation](configuration/modules/index.md)
./docs/index.md:Read this [documentation](tools/index.md)
./docs/index.md:Read this [documentation](tutorials/index.md)
./docs/loadflow/security-analysis.md:Read this [documentation](../contingencies/index.md)
./docs/loadflow/security-analysis.md:Read this [documentation](../configuration/parameters/SecurityAnalysisParameters.md)
./docs/configuration/modules/mapdb-app-file-system.md:Read the [documentation](../../afs/afs-mapdb.md)
./docs/configuration/modules/local-app-file-system.md:Read the [documentation](../../afs/afs-local.md)
./docs/configuration/modules/groovy-dsl-contingencies.md:Read the [documentation](../../contingencies/GroovyDslContingenciesProvider.md)
./docs/tools/loadflow-validation.md:Read this [documentation](http://rte-france.github.io/hades2/index.html)
./docs/tools/action-simulator.md:Read this [documentation](http://rte-france.github.io/hades2/index.html)
./docs/tools/run-impact-analysis.md:read this [documentation](../contingencies/index.md)
./docs/tools/loadflow.md:Read this [documentation](http://rte-france.github.io/hades2/index.html)
./docs/tools/afs.md:Read the [documentation]()
./docs/tools/sensitivity-computation.md:read this [documentation](../sensitivity/index.md)
./docs/tools/security-analysis.md:read this [documentation](../contingencies/index.md)
./docs/tools/security-analysis.md:Read this [documentation](../loadflow/security-analysis.md)
./docs/tools/security-analysis.md:Read this [documentation](http://rte-france.github.io/hades2/index.html)

• What is the expected behavior?
  You should be able to get a basic understanding of where a link takes you to just by looking at it, not having to read a full paragraph of text around it.

• What is the motivation / use case for changing the behavior?
  Make a better documentation

• Do you want to request a feature or report a bug?
  Feature

• What is the current behavior?
  In PR #172, @MioRtia added documentation about an option to configure CGMES importers post-processor. There is no such processor in powsybl-core, but there is one in the powsybl-single-line-diagram that is not documented yet

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

• What is the expected behavior?
  Add a short description of the CgmesDLImportPostProcessor class, and explain in the CGMES importer documentation how to use it by giving at least its name (and eventually its configuration).

• What is the motivation / use case for changing the behavior?

• Please tell us about your environment:

  • PowSyBl Version: ...
  • OS Version: ...

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)

• Do you want to request a feature or report a bug?
  feature

• What is the current behavior?

Needs loadflow documentations

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

• What is the expected behavior?

• What is the motivation / use case for changing the behavior?

• Please tell us about your environment:

  • PowSyBl Version: ...
  • OS Version: ...

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)

• Do you want to request a feature or report a bug?
  feature/enhancement

• What is the current behavior?
  https://www.powsybl.org/pages/documentation/user/

Does not mention that Java run time is a requirement.

• What is the expected behavior?
  I would add a line: "In order to run PowSyBl you need to have a java run time installed. (e.g. on Linux the default-jdk)"

I think it would be useful for new users to know what java runtime should they install - I am happy to make a PR with this change.

• Do you want to request a feature or report a bug?
  Request

• What is the current behavior?
  The documentation of the dynamic-simulation tool doesn't exist.

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

• What is the expected behavior?
  Have a complete documentation of this tool. A link to this new page has to be available from the menu (User documentation section) and from the itools page

• What is the motivation / use case for changing the behavior?
  Be exhaustive

• Please tell us about your environment:

  • PowSyBl Version: 3.1.0
  • OS Version: All

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, spectrum, etc)

(if a question doesn't apply, you can delete it)