Documentation #46
Merged
Documentation #46
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SebWae
reviewed
Dec 18, 2024
README.md
Outdated
|
|
||
| ### Triggering GitHub Workflow | ||
|
|
||
| The workflow can be triggered either on pull requests to main or manually. |
Collaborator
There was a problem hiding this comment.
Write main using typewriter font: main
SebWae
reviewed
Dec 18, 2024
README.md
Outdated
| <a target="_blank" href="https://cookiecutter-data-science.drivendata.org/"> | ||
| <img src="https://img.shields.io/badge/CCDS-Project%20template-328F97?logo=cookiecutter" /> | ||
| </a> | ||
| This project is part of the Software Development and Software Engineering at ITU. The original project description can be found [here](https://github.com/lasselundstenjensen/itu-sdse-project) |
Collaborator
There was a problem hiding this comment.
Add "course" after "Software Engineering" and finish the sentence with a period.
SebWae
reviewed
Dec 18, 2024
| This project is part of the Software Development and Software Engineering at ITU. The original project description can be found [here](https://github.com/lasselundstenjensen/itu-sdse-project) | ||
|
|
||
| A short description of the project. | ||
| In this project we were tasked with restructuring a Python monolith using the concepts we have learned throughout the course. This project contains a [Dagger workflow](https://github.com/PLtier/github-dagger-workflow-project/blob/main/pipeline.go) and a [GitHub workflow](https://github.com/PLtier/github-dagger-workflow-project/blob/main/.github/workflows/test_action.yml). |
Collaborator
There was a problem hiding this comment.
Maybe add "structuring an MLOps workflow" in the end of the sentence.
Collaborator
Author
There was a problem hiding this comment.
Where is exactly do you mean?
Collaborator
There was a problem hiding this comment.
Exactly where you placed it 😉
SebWae
reviewed
Dec 18, 2024
Collaborator
SebWae
left a comment
SebWae
left a comment
There was a problem hiding this comment.
I think the documentation covers our needs and the scope of the project. I've added some comments suggesting minor changes.
SebWae
previously approved these changes
Dec 18, 2024
| This project is part of the Software Development and Software Engineering at ITU. The original project description can be found [here](https://github.com/lasselundstenjensen/itu-sdse-project) | ||
|
|
||
| A short description of the project. | ||
| In this project we were tasked with restructuring a Python monolith using the concepts we have learned throughout the course. This project contains a [Dagger workflow](https://github.com/PLtier/github-dagger-workflow-project/blob/main/pipeline.go) and a [GitHub workflow](https://github.com/PLtier/github-dagger-workflow-project/blob/main/.github/workflows/test_action.yml). |
Collaborator
There was a problem hiding this comment.
Exactly where you placed it 😉
SebWae
previously approved these changes
Dec 19, 2024
Collaborator
SebWae
left a comment
SebWae
left a comment
There was a problem hiding this comment.
Very thoroughly documentation. I think everything is documented now.
SebWae
approved these changes
Dec 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Can probably be added a bit more to it, but thought it was good start to at least have a useable readme on main