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

[ci skip] Update Documentation - Pyiron release chapter #609

Merged
merged 19 commits into from Jan 26, 2022

Conversation

Ovakefali13
Copy link
Contributor

@Ovakefali13 Ovakefali13 commented Dec 30, 2021

Relates to issue #599 and #590.

This PR is still work in progress, please feel free to add things and/or comment on things that might feel unclear.

What I changed:

  • Added chapter for distribution
    • Rearanged links
    • Updated chapter structure
    • Deleted Travis
  • Added chapter for Building process
    • Added steps that take place to release different distributions
  • Added chapter for Github workflow
    • Added links to the different Github workflows
    • Added descriptions of Github workflows
  • Added comments to the workflow files

What I still want to do:

  • Add descriptions for docs.yml
  • Add descriptions for notebooks.yml
  • Add descriptions for pypicheck.yml
  • Add descriptions for unittests.yml
  • Add first sentence of documentation to each workflow
  • Change from draft to PR

@Ovakefali13 Ovakefali13 added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Dec 30, 2021
@Ovakefali13 Ovakefali13 changed the title [ci skip] Update Pyiron release chapter [ci skip] Update Documentation - Pyiron release chapter Jan 9, 2022
CONTRIBUTING.rst Outdated Show resolved Hide resolved
@Ovakefali13
Copy link
Contributor Author

Ovakefali13 commented Jan 11, 2022

@niklassiemer While going through the workflows I noticed that some of the comments inside appear to be outdated as well. E.g.

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

I'm currently writing a short descripition for each of these workflows and am thinking about changing these comments with a new short sentence about what the workflow actually does. Should I open a new issue for this (and or create a new PR) or should I just do this within the current PR (seems a bit bad practice).

@niklassiemer
Copy link
Member

You are absolutely right. The comments are from a first version of these GitHub workflows and are quite outdated. I think we started with a unittest workflow (for which the sentence is ok) and copied the workflow without changing the description.
Since this is all 'Documentation' I would be happy to simply handle your improvements within this PR. However, feel free to open a new PR to update the workflow documentation.

Copy link
Member

@niklassiemer niklassiemer left a comment

Choose a reason for hiding this comment

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

Thanks a lot for updating this! I found quite some stuff where our previous documentation was to bad to get what is actually going on...

CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Show resolved Hide resolved
CONTRIBUTING.rst Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
Ovakefali13 and others added 4 commits January 12, 2022 21:28
Co-authored-by: Niklas Siemer <70580458+niklassiemer@users.noreply.github.com>
Co-authored-by: Niklas Siemer <70580458+niklassiemer@users.noreply.github.com>
@Ovakefali13
Copy link
Contributor Author

Ovakefali13 commented Jan 12, 2022

You are absolutely right. The comments are from a first version of these GitHub workflows and are quite outdated. I think we started with a unittest workflow (for which the sentence is ok) and copied the workflow without changing the description. Since this is all 'Documentation' I would be happy to simply handle your improvements within this PR. However, feel free to open a new PR to update the workflow documentation.

Ok i keep it here so it is simpler

@Ovakefali13
Copy link
Contributor Author

I will add the last missing workflows until the end of this week, add the first lines of each of these to the corresponding workflow and then change the PR from draft to actual PR for final review

@Ovakefali13 Ovakefali13 marked this pull request as ready for review January 13, 2022 19:00
Copy link
Member

@niklassiemer niklassiemer left a comment

Choose a reason for hiding this comment

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

I made a few corrections, but otherwise LGTM.

.github/workflows/UpdateDependabotPR.yml Outdated Show resolved Hide resolved
.github/workflows/notebooks.yml Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
Ovakefali13 and others added 2 commits January 23, 2022 14:38
Co-authored-by: Niklas Siemer <70580458+niklassiemer@users.noreply.github.com>
Copy link
Member

@niklassiemer niklassiemer left a comment

Choose a reason for hiding this comment

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

One typo and then this is good to go :) Thanks!

CONTRIBUTING.rst Outdated Show resolved Hide resolved
@niklassiemer niklassiemer linked an issue Jan 24, 2022 that may be closed by this pull request
Co-authored-by: Niklas Siemer <70580458+niklassiemer@users.noreply.github.com>
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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Outdated Link in CONTRIBUTING.rst
2 participants