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.

Sign up for GitHub

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

Jump to bottom

[Docs] Updates for SDG README #281

Merged
merged 3 commits into from
Nov 22, 2024
Merged

[Docs] Updates for SDG README #281

merged 3 commits into from
Nov 22, 2024

Conversation

kelbrown20
Copy link
Contributor

@kelbrown20 kelbrown20 commented Sep 18, 2024 •
edited
Loading

Description:
Adding some more content to the SDG README.md

@mergify mergify bot added documentation Improvements or additions to documentation ci-failure labels Sep 18, 2024
kelbrown20
kelbrown20 commented Sep 18, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@kelbrown20 kelbrown20 force-pushed the update-readme branch 2 times, most recently from db702e3 to c627a20 Compare September 18, 2024 17:57
@mergify mergify bot added ci-failure and removed ci-failure labels Sep 18, 2024
@kelbrown20 kelbrown20 force-pushed the update-readme branch 3 times, most recently from 70ceff8 to cd2af8d Compare September 19, 2024 17:11
@mergify mergify bot removed the ci-failure label Sep 19, 2024
khaledsulayman
khaledsulayman reviewed Sep 23, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@mergify mergify bot added the ci-failure label Sep 25, 2024
@kelbrown20 kelbrown20 force-pushed the update-readme branch 2 times, most recently from 36ffb2f to 1ab676c Compare November 19, 2024 16:07
@mergify mergify bot removed the ci-failure label Nov 19, 2024
@bbrowning
Copy link
Contributor

Kelly, how would you like me to contribute to this to fill in some of the missing sections? We can merge this as-is and I can add more commits on top in another pull request. Or, I can potentially push more commits into this pull request to fill out some of the unknowns. I'm open to either way, depending on your preference and comfort with a bit more advanced git workflow, in the case of me adding commits directly to this PR.

@kelbrown20
Copy link
Contributor Author

I was also thinking about the best way to with this for collaboration. I think pushing commits to this PR would be the best option!

@mergify mergify bot added the ci-failure label Nov 20, 2024
@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 20, 2024

This pull request has merge conflicts that must be resolved before it can be
merged. @kelbrown20 please rebase it. https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added CI/CD Affects CI/CD configuration needs-rebase and removed ci-failure labels Nov 20, 2024
@mergify mergify bot added ci-failure and removed needs-rebase labels Nov 20, 2024
@bbrowning
Flesh out some of the technical details of SDG README.md
d88ec91 
This fills in some placeholder sections of our updated README.md. It's
not as detailed as it should eventually be, but at least gives a bit
more information as users browse the repository.

Signed-off-by: Ben Browning <[email protected]>
@mergify mergify bot removed the ci-failure label Nov 20, 2024
@bbrowning
Copy link
Contributor

Sorry for the noise here - I had to update the list of spellcheck words, and that caused a merge conflict so had to rebase both of our commits on top of the latest main to get things happy.

@kelbrown20
Copy link
Contributor Author

Thank you for adding those technical details @bbrowning!
Are there any other details we want added here or is this a good start? cc @aakankshaduggal @khaledsulayman

aakankshaduggal
aakankshaduggal approved these changes Nov 21, 2024
View reviewed changes
Copy link
Member

@aakankshaduggal aakankshaduggal left a comment

Choose a reason for hiding this comment

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

Thanks @kelbrown20 and @bbrowning. This is a good start, we can continue to add more information and documentation in following PRs.

@mergify mergify bot added the one-approval label Nov 21, 2024
@aakankshaduggal aakankshaduggal merged commit 01d7f89 into instructlab:main Nov 22, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aakankshaduggal aakankshaduggal aakankshaduggal approved these changes

@khaledsulayman khaledsulayman Awaiting requested review from khaledsulayman

@bbrowning bbrowning Awaiting requested review from bbrowning

Assignees
No one assigned
Labels
CI/CD Affects CI/CD configuration documentation Improvements or additions to documentation one-approval
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@kelbrown20 @bbrowning @aakankshaduggal @khaledsulayman