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

Refactor Getting Started and add Licensing #1423

Merged
merged 21 commits into from
Feb 21, 2024

Conversation

PProfizi
Copy link
Contributor

@PProfizi PProfizi commented Feb 16, 2024

This PR updates the documentation regarding the DPF licensing for 2024.2.pre0.
Also documents dyna as a valid license increment.

Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
@PProfizi PProfizi added the documentation Improvements or additions to documentation label Feb 16, 2024
@PProfizi PProfizi added this to the v0.11.0 milestone Feb 16, 2024
@PProfizi PProfizi self-assigned this Feb 16, 2024
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Copy link

codecov bot commented Feb 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b59499e) 87.85% compared to head (f60c675) 87.84%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1423      +/-   ##
==========================================
- Coverage   87.85%   87.84%   -0.02%     
==========================================
  Files          81       81              
  Lines        9543     9543              
==========================================
- Hits         8384     8383       -1     
- Misses       1159     1160       +1     

Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
doc/source/getting_started/licensing.rst Outdated Show resolved Hide resolved
doc/source/getting_started/licensing.rst Outdated Show resolved Hide resolved
@rafacanton
Copy link
Contributor

@PProfizi As a generic comment, I think that the general licensing doc is a bit convoluted. We have it in 2 places:

  • The Getting started with DPF Server section, with all the License terms and increments
  • The new License page.

Do you think we could merge both in one page? (that way if a user wants to know about licensing they don't need to go back-and-forth between 2 pages)

Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
@PProfizi
Copy link
Contributor Author

PProfizi commented Feb 19, 2024

@PProfizi As a generic comment, I think that the general licensing doc is a bit convoluted. We have it in 2 places:

  • The Getting started with DPF Server section, with all the License terms and increments
  • The new License page.

Do you think we could merge both in one page? (that way if a user wants to know about licensing they don't need to go back-and-forth between 2 pages)

I agree that information is a bit all over the place. Still, the idea was to have this new page dedicated to licensing, whereas the Getting Started with DPF Server is still useful as a guideline on installing DPF as a standalone. I planned on moving it to the Getting started section though. I'll see how to make this nicer.

Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
Signed-off-by: paul.profizi <paul.profizi@ansys.com>
@PProfizi PProfizi changed the title Update the licensing information in the documentation Refactor documentation Getting Started and add Licensing Feb 20, 2024
@PProfizi PProfizi changed the title Refactor documentation Getting Started and add Licensing Refactor Getting Started and add Licensing Feb 20, 2024
@rafacanton
Copy link
Contributor

rafacanton commented Feb 21, 2024

@PProfizi Thanks or all the refactoring, I think that the doc is very clear and modularized! (I just added minor comments about versioning strings that we may want to explicitly delete, or to make sure that we will update with each new server release)

Signed-off-by: paul.profizi <paul.profizi@ansys.com>
@PProfizi
Copy link
Contributor Author

Thanks @rafacanton, I updated the versions as you remarked.
I indeed hope this will be clearer for the end user.
I will from now on be making a clear distinction between the getting started (everything related to installation and running a script, as well as very basic usage) and the user guide (where we describe features and in-depth usage)

Signed-off-by: paul.profizi <paul.profizi@ansys.com>
@PProfizi PProfizi merged commit e13c72f into master Feb 21, 2024
40 checks passed
@PProfizi PProfizi deleted the doc/update_licensing_behavior_standalone branch February 21, 2024 10:21
@PProfizi
Copy link
Contributor Author

Thanks @JennaPaikowsky! I'll implement the changes in the next PR.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation on licensing behavior Add "dyna" as valid license increment
3 participants