Skip to content

DOC: legal process to perform a public release of a PyAnsys library #236

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

Merged
merged 22 commits into from
Jan 12, 2023

Conversation

jorgepiloto
Copy link
Member

@jorgepiloto jorgepiloto commented Jan 11, 2023

Fix #232. This pull-request improves the section regarding the legal process required to perform a public release of a PyAnsys library. The following modifications were made:

  • Document in detail the approval process.
  • Document the public release process. Reorganize the associated section in the How-To guide.
  • Rename the "Overview" chapter as "Getting started".
  • Use panels to collect grid elements pointing to common documentation chapters and sections.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 11, 2023
@jorgepiloto jorgepiloto force-pushed the doc/public-release branch 3 times, most recently from a6b716d to a5dea77 Compare January 11, 2023 10:14
@jorgepiloto
Copy link
Member Author

This is taking a bit more than expected but the results are looking really good. I am really taking care of the layout and structure so this is presented in a clean way to readers.

@jorgepiloto jorgepiloto marked this pull request as ready for review January 12, 2023 07:46
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

Overall it's looking good! Mostly editorial comments. I'll leave it approved, pending the resolution of my comments

jorgepiloto and others added 2 commits January 12, 2023 09:43
Co-authored-by: Roberto Pastor Muela <roberto.pastormuela@ansys.com>
Copy link
Contributor

@MaxJPRey MaxJPRey left a comment

Choose a reason for hiding this comment

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

Look's great.

@RobPasMue
Copy link
Member

It looks like there are some issues in the build process. Can you look into them before merging @jorgepiloto?

@jorgepiloto
Copy link
Member Author

I think it would be nice to include a documentation review inside the technical part of the process. I am not talking about documentation guidelines but quality. This is something @pyansys/documentation team should perform.

@RobPasMue
Copy link
Member

I think it would be nice to include a documentation review inside the technical part of the process. I am not talking about documentation guidelines but quality. This is something @pyansys/documentation team should perform.

Agreed, it should be a must.

jorgepiloto and others added 2 commits January 12, 2023 15:50
Co-authored-by: Alex Kaszynski <akascap@gmail.com>
@jorgepiloto jorgepiloto merged commit 342d87e into main Jan 12, 2023
@jorgepiloto jorgepiloto deleted the doc/public-release branch January 12, 2023 14:59
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.

Add public release documentation
5 participants