-
Notifications
You must be signed in to change notification settings - Fork 25
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
Improve Compatibility documentation #256
Conversation
PProfizi
commented
Jun 2, 2022
•
edited
Loading
edited
- The compatibility table should be at the start of the "Getting Started" page
- It mentions having to synchronize the ansys.grpc.dpf module but not explicitly the server and python client compatibility
- The "Architecture" section mentions Ansys 2021R2 as required while the "Installation with PIP" section mentions "Ansys 2021 R1 or later" and gives only the command pip install ansys-dpf-core which is wrong is using Ansys 2021R1 (should be pip install ansys-dpf-core<0.3.0)
- We might actually want to mention compatibility in the ReadMe, along with specifying that the installation command is for Ansys 2021 R2 onward.
- We can also customize the Issue template to add a tick box with "I made sure I am following the Compatibility guidelines", with an hyperlink to the doc.
- The Ansys 2021R1 row of the table should be visually separated in some way (thicker boundaries?) --> Could not find how to do this
Codecov Report
@@ Coverage Diff @@
## master #256 +/- ##
=======================================
Coverage 85.77% 85.77%
=======================================
Files 52 52
Lines 5702 5702
=======================================
Hits 4891 4891
Misses 811 811 |
|
||
Other platforms may be supported by using DPF within a | ||
containerization ecosystem such as Docker or Kubernetes. | ||
For more information, see :ref:`docker`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@PProfizi I don't think that the docker page is up to date, we should not add links to it until it is, what do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cbellot000 agreed.
Co-authored-by: Camille Bellot <80476446+cbellot000@users.noreply.github.com>