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

Improve Compatibility documentation #256

Merged
merged 7 commits into from
Jun 2, 2022

Conversation

PProfizi
Copy link
Contributor

@PProfizi PProfizi commented Jun 2, 2022

  • 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

@PProfizi PProfizi added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Jun 2, 2022
@PProfizi PProfizi self-assigned this Jun 2, 2022
@PProfizi PProfizi linked an issue Jun 2, 2022 that may be closed by this pull request
@PProfizi PProfizi marked this pull request as draft June 2, 2022 09:56
@codecov
Copy link

codecov bot commented Jun 2, 2022

Codecov Report

Merging #256 (8bb33d1) into master (8dafee0) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #256   +/-   ##
=======================================
  Coverage   85.77%   85.77%           
=======================================
  Files          52       52           
  Lines        5702     5702           
=======================================
  Hits         4891     4891           
  Misses        811      811           

@PProfizi PProfizi marked this pull request as ready for review June 2, 2022 13:32
@PProfizi PProfizi requested a review from cbellot000 June 2, 2022 13:32

Other platforms may be supported by using DPF within a
containerization ecosystem such as Docker or Kubernetes.
For more information, see :ref:`docker`.
Copy link
Contributor

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cbellot000 agreed.

PProfizi and others added 2 commits June 2, 2022 18:33
Co-authored-by: Camille Bellot <80476446+cbellot000@users.noreply.github.com>
@PProfizi PProfizi merged commit 18bc234 into master Jun 2, 2022
@PProfizi PProfizi deleted the doc/improve_Compatibility_documentation branch June 2, 2022 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
2 participants