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: 📝 add code along on renaming, editing, and moving files to working-with-files #66

Open
wants to merge 22 commits into
base: main
Choose a base branch
from

Conversation

signekb
Copy link
Member

@signekb signekb commented Feb 26, 2025

Description

This PR adds a code along on renaming editing and moving the soup.md file to working-with-files

Related to #63

This PR needs an in-depth review.

Checklist

  • Formatted Markdown
  • Ran just run-all

@signekb signekb requested a review from lwjohnst86 as a code owner February 26, 2025 14:45
@signekb signekb changed the base branch from main to docs/add-the-first-recipe-code-along February 26, 2025 14:45
@signekb signekb changed the title docs: 📝 add code along on renaming editing and moving files in working-with-files docs: 📝 add code along on renaming editing and moving files to working-with-files Feb 26, 2025
When we edit the content of the file in the code along
@signekb signekb changed the title docs: 📝 add code along on renaming editing and moving files to working-with-files docs: 📝 add code along on renaming, editing, and moving files to working-with-files Feb 26, 2025
@signekb
Copy link
Member Author

signekb commented Feb 26, 2025

I'll leave this PR stacked, but won't stack this kind of content going forward 🚀

@signekb
Copy link
Member Author

signekb commented Feb 26, 2025

Following the feedback from the other PR, I have changed "you" to "we" in the code along. This is now ready for review 👩‍🎤

Base automatically changed from docs/add-the-first-recipe-code-along to main February 26, 2025 16:32
@lwjohnst86
Copy link
Member

@signekb can you resolve the conflicts so I know what to review?

@signekb
Copy link
Member Author

signekb commented Feb 27, 2025

@lwjohnst86 Done ✅

@lwjohnst86
Copy link
Member

Reviewing this PR right now! 📖 ✍️ 👀

Copy link
Member

@lwjohnst86 lwjohnst86 left a comment

Choose a reason for hiding this comment

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

Nice! Some suggestions 😁

Comment on lines 209 to 210
Once we have renamed the file, let's click the green "Commit changes" button
and commit the changes.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Once we have renamed the file, let's click the green "Commit changes" button
and commit the changes.
Once we have renamed the file, click the "Commit changes" button on the right side of the page. When the commit message box pops up, write in the message something like: "renamed file to something more specific". Then click the "Commit changes" button on the bottom of the message box.

Workshop material needs to be really precise to the tasks we're doing. Since this is on Git and GitHub, we need to be detailed about all the steps.

Since we'll repeat this many times, might be worth it to consider using {{< var >}} shortcodes to insert repeated text.

We also should be careful about saying colours. On my computer, I have it as blue (colour blind friendly).

Copy link
Member Author

@signekb signekb Mar 7, 2025

Choose a reason for hiding this comment

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

Ah, that’s some good points. I’ll create a short code with the commit steps.
About colours: could we write that it’s green by default or should we just omit the mention of a colour altogether?

Copy link
Member

Choose a reason for hiding this comment

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

I'll make an issue to discuss this. We don't need to commit to it immediately ☺️

Copy link
Member Author

Choose a reason for hiding this comment

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

#75

Copy link
Member Author

@signekb signekb Mar 7, 2025

Choose a reason for hiding this comment

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

In the github-commit variable I just added I don’t mention the colour of the buttons 🟢

Co-authored-by: Luke W. Johnston <lwjohnst86@users.noreply.github.com>
@signekb signekb requested a review from lwjohnst86 March 7, 2025 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In progress
Development

Successfully merging this pull request may close these issues.

2 participants