fedora-commops / fedora-happiness-packets

#135 Updated the setup docs(Windows) to suggest user to use `ssh` during cloning the repo.
Merged by jflory7. Opened by phoenixabhishek.
Unknown source master

Download 135.patch

  1. What is a summary of your change?
    The current document provides both approaches(http and ssh) for users to clone the repository.
    However, based on some recent new-user experience it was found that users get an error while pushing changes when ssh method is not used.
    Change is based out of this suggestion

  2. Why is this change helpful?
    This new change suggests that ssh is the recommended way to go forward when cloning the repository for the setup.
    This will prevent future new-users to avoid the current issue faced.

  3. Any specific details to consider?
    These can also be updated on the other docs as well.

  4. What do you think is the outcome of this change?
    The user, on initial steps itself, will use ssh approach with the repository, and will be able to execute tasks(push/pull) successfully.
phoenixabhishek commented

@jflory7 please review if this addresses the issue that is faced by our new users.

These are nitpicks, but please add whitespace before the starting parentheses (repository (SSH method is) and remove whitespace before the end parentheses (first_steps.html>_)`).

Hi @phoenixabhishek, thanks for the PR to add better clarity. :thumbsup:

These can also be updated on the other docs as well.

Do you think you can update the docs for both pages?

I feel like it might be better to avoid writing the same steps twice that don't change between Windows and UNIX. A way to make this page easier to maintain could be detailing only the differences from the main dev environment setup page. But I think this would be better in a different pull request.

For now, if you can also update the other page's instructions to keep these two in sync, that would be helpful too.

1 new commit added

  • update ssh details for cloning on setup
phoenixabhishek commented

I feel like it might be better to avoid writing the same steps twice that don't change between Windows and UNIX. A way to make this page easier to maintain could be detailing only the differences from the main dev environment setup page. But I think this would be better in a different pull request.

Yes, we can have a new PR to address this issue.

For now, if you can also update the other page's instructions to keep these two in sync, that would be helpful too.

Okk, I'll do that :thumbsup: :thumbsup: :thumbsup: :thumbsup: :thumbsup:

1 new commit added

  • updated the docs for non-windows systems for using ssh

1 new commit added

  • document formatted for proper list numbers

rebased onto 8a62f0c8fd72277b5c8d1e0c8ce5756a404ff120
phoenixabhishek commented

@jflory I've made the necessary changes currently.
Also, squashed multiple commits to one.

Please see if this is good to merge :smile: :smile: :smile: :smile: :smile:

Edited by phoenixabhishek

@phoenixabhishek Looks good! Merging this in. :clapper:

Pull-Request has been merged by jflory7
Metadata
None
No Tags
Static archive. pagure.io was sunset in 2026; this is a read-only snapshot.
Red Hat Logo

Fedora is sponsored by Red Hat. Learn more about the relationship between Red Hat and Fedora »

© Red Hat, Inc. and others.