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

Update first_steps.md #14152

Closed
wants to merge 2 commits into from
Closed

Update first_steps.md #14152

wants to merge 2 commits into from

Conversation

Alwoch
Copy link

@Alwoch Alwoch commented Sep 24, 2024

The current documentation seems to imply that we are updating snap. I just had to specify that its the lxd snap we're updating to avoid confusion

The current documentation seems to imply that we are updating snap. I just had to specify that its the lxd snap we're updating to avoid confusion

Signed-off-by: Alwoch Sophia <salwoch@gmail.com>
@github-actions github-actions bot added the Documentation Documentation needs updating label Sep 24, 2024
Copy link
Contributor

@MggMuggins MggMuggins left a comment

Choose a reason for hiding this comment

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

One nit :)

doc/tutorial/first_steps.md Outdated Show resolved Hide resolved
@MggMuggins
Copy link
Contributor

Also can you please sign Canonical's CLA?

Signed-off-by: Alwoch Sophia <salwoch@gmail.com>
Copy link

Heads up @mionaalex - the "Documentation" label was applied to this issue.

@Alwoch
Copy link
Author

Alwoch commented Sep 25, 2024

Also can you please sign Canonical's CLA?

Done! also I've modified it to conform to the convention

@MggMuggins
Copy link
Contributor

Thanks; can you also rebase the PR into one commit and use the commit title convention that's described here?

@simondeziel
Copy link
Member

git rebase -i main should be all you need to then mark the last commit (capitalize LXD) for fixup. This will "merge" or "fuse" the 2 commits into one.

After that, you should be able to push with force: git push -f

@tomponline
Copy link
Member

tomponline commented Oct 22, 2024

Hi @minaelee please could you assist with either getting this contribution ready to be merged, or potentially make the change yourself (whilst maintaining attribution to @Alwoch ) and we can close this? Thanks

@minaelee
Copy link
Contributor

@Alwoch Thanks for your contribution! I see that it's your first contribution to Canonical, and I'd love to help you get it ready for merge.

Here are detailed instructions to rebase as well as to update the commit message:

  • In a terminal, in a local clone of your fork of the lxd repository, switch to your PR branch (patch-1). (Note: if you used the GH web interface to make your commits and PR instead of a local clone, you'll need to clone your forked repository locally, checkout/switch to the PR branch there (git switch -c patch-1 origin/patch-1), then sync with git pull origin patch-1 before you rebase.)
  • Then run git rebase -i main in your terminal. This will open the text editor set for git, or the default system editor if one isn't set for git.
  • In the text editor, you should see a list of your recent commits. To the left of the last commit, change the text pick to fixup. Save & exit the editor.
  • Run git commit --amend. This will open the editor again. In it, edit your commit message to something like doc/tutorial: specify LXD snap and save & exit.
  • Force push the changes with git push -f.

Reach out if you have questions. In the interest of completing this change, I will wait a week and if I haven't heard back, I will close this PR and open a new one with attribution to you.

@Alwoch
Copy link
Author

Alwoch commented Oct 31, 2024

@Alwoch Thanks for your contribution! I see that it's your first contribution to Canonical, and I'd love to help you get it ready for merge.

Here are detailed instructions to rebase as well as to update the commit message:

  • In a terminal, in a local clone of your fork of the lxd repository, switch to your PR branch (patch-1). (Note: if you used the GH web interface to make your commits and PR instead of a local clone, you'll need to clone your forked repository locally, checkout/switch to the PR branch there (git switch -c patch-1 origin/patch-1), then sync with git pull origin patch-1 before you rebase.)
  • Then run git rebase -i main in your terminal. This will open the text editor set for git, or the default system editor if one isn't set for git.
  • In the text editor, you should see a list of your recent commits. To the left of the last commit, change the text pick to fixup. Save & exit the editor.
  • Run git commit --amend. This will open the editor again. In it, edit your commit message to something like doc/tutorial: specify LXD snap and save & exit.
  • Force push the changes with git push -f.

Reach out if you have questions. In the interest of completing this change, I will wait a week and if I haven't heard back, I will close this PR and open a new one with attribution to you.

Hi @minaelee , you can go ahead and open a new PR because I'm avoiding cloning the repository. Thanks

@minaelee
Copy link
Contributor

minaelee commented Nov 4, 2024

Closing in favor of #14382; thanks @Alwoch!

@minaelee minaelee closed this Nov 4, 2024
tomponline added a commit that referenced this pull request Nov 5, 2024
- specify that it is the LXD snap and not snap in general that is being
referred to in the tutorial, per contribution by @Alwoch #14152
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants