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

docs: describe workflow rationale #135

Merged
merged 23 commits into from
Aug 19, 2024
Merged

Conversation

deliaBlue
Copy link
Collaborator

@deliaBlue deliaBlue commented Jan 31, 2024

This PR closes #126.

The changes applied are:

  • Correct file extensions, typos, explanations and add examples in some rules in the pipeline_documentation.md
  • Expand the workflow description and fix typos in the main README.

@deliaBlue deliaBlue added the documentation Improvements or additions to documentation label Jan 31, 2024
@deliaBlue deliaBlue self-assigned this Jan 31, 2024
@deliaBlue deliaBlue linked an issue Jan 31, 2024 that may be closed by this pull request
3 tasks
Copy link
Member

@uniqueg uniqueg left a comment

Choose a reason for hiding this comment

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

Couple of issues, but shouldn't take long to fix. Didn't look at all of the many changes in the pipeline documentation file carefully - but it looks mostly fine :)

To be fair, it's probably one of the 10 most detailed pipeline documentations ever written 🤣

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
pipeline_documentation.md Outdated Show resolved Hide resolved
pipeline_documentation.md Outdated Show resolved Hide resolved
pipeline_documentation.md Outdated Show resolved Hide resolved
pipeline_documentation.md Outdated Show resolved Hide resolved
pipeline_documentation.md Outdated Show resolved Hide resolved
@uniqueg
Copy link
Member

uniqueg commented Mar 18, 2024

Oh, and please check why the static code analysis fails.

Copy link
Member

@uniqueg uniqueg left a comment

Choose a reason for hiding this comment

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

Please address the open comments and send for re-review when you are done 🙏

@uniqueg
Copy link
Member

uniqueg commented Aug 6, 2024

@deliaBlue: Somehow this PR showed up in my GitHub notifications, probably because you added commits? Is there anything I should do at this point? Or am I still waiting until you resolve the open conversations and tell me to review? :)

@deliaBlue
Copy link
Collaborator Author

@deliaBlue: Somehow this PR showed up in my GitHub notifications, probably because you added commits? Is there anything I should do at this point? Or am I still waiting until you resolve the open conversations and tell me to review? :)

Righr now this PR lacks the documentation of the recently-merged PRs. Also, the unsolved comments are halfway through. We discussed them a while ago but leave the PR for when the other PRs were merged due to the different style in the documentation. As soon as it is done, I will ask you to review it :)

@deliaBlue deliaBlue requested a review from uniqueg August 17, 2024 13:58
Copy link
Member

@uniqueg uniqueg left a comment

Choose a reason for hiding this comment

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

This looks great! :)

@deliaBlue deliaBlue merged commit 7dbeb42 into dev Aug 19, 2024
8 checks passed
@deliaBlue deliaBlue deleted the 126-docs-describe-workflow-rationale branch August 19, 2024 10:27
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.

docs: describe workflow rationale
2 participants