Git client and screenshots #64

ivan-paleo commented 2020年09月16日 14:31:17 +02:00

[Sorry again for a somewhat loose title...]

I've been reading the sections Working with Git Repositories and Collaborating with Others of the documentation.

The whole documentation is showing how to use Git through command lines. That might reflect the majority of Codeberg users, but personally, I use RStudio (which is not a Git client per se, but it works perfectly for me because I do only R). And I kind of expect that someone who understands these commands does not really need to have them on the Codeberg documentation because they are Git commands. But maybe I'm assuming things. Either way, it is not even mentioned where the commands should be typed in: Git Bash, Terminal/Command Prompt... (platform-specific of course).

On the topic of Git clients, does the Codeberg community recommends a given Git client? Whatever the answer, I think a subsection on this topic could be helpful. A link to the page on GUI clients on the Git website would also be nice.

Finally, adding documentation (with screenshots) on how to perform all these actions from the web interface would be very important too, IMHO.

[Sorry again for a somewhat loose title...] I've been reading the sections [Working with Git Repositories](https://docs.codeberg.org/git/) and [Collaborating with Others](https://docs.codeberg.org/collaborating/) of the documentation. The whole documentation is showing how to use Git through command lines. That might reflect the majority of Codeberg users, but personally, I use RStudio (which is not a Git client per se, but it works perfectly for me because I do only R). And I kind of expect that someone who understands these commands does not really need to have them on the Codeberg documentation because they are Git commands. But maybe I'm assuming things. Either way, it is not even mentioned where the commands should be typed in: Git Bash, Terminal/Command Prompt... (platform-specific of course). On the topic of Git clients, does the Codeberg community recommends a given Git client? Whatever the answer, I think a subsection on this topic could be helpful. A link to the [page on GUI clients on the Git website](https://git-scm.com/downloads/guis) would also be nice. Finally, adding documentation (with screenshots) on how to perform all these actions from the web interface would be very important too, IMHO.

ashimokawa commented 2020年09月16日 15:16:40 +02:00

Yep, personally, I use the command line (I am so old that there was no gui when I started usin git).

Also I am on Linux 100% of the time, but think the "Git Bash" that you mention is a windows tool that bundles bash with git as a command line tool. Yes that is where the commands we refer to should be entered.

When I use a GUI I use gitk or gitg to browse, history, branches, the stash etc. Those also might be linux specific tools.

Also most IDEs (Android Studio, vs code, etc) have built-in git support. But this is specific to the IDE and has not much todo with using codeberg in particular (at least I think so).

You could argue that the command line is also not codeberg specific, but mentioning how to work with the command line is at least a common base, which works on any OS, and the git client is the official reference client.

I do not object taking screenshots and explaining things for GUI users, as long as those GUIs are free software, but certainly I am not the right person to write such an article.

Maybe it would be good to at least have a small introduction on how to install the git command line client on Windows, Linux, and macOS (I assume it is shipped with git).

Yep, personally, I use the command line (I am so old that there was no gui when I started usin git). Also I am on Linux 100% of the time, but think the "Git Bash" that you mention is a windows tool that bundles bash with git as a command line tool. Yes that is where the commands we refer to should be entered. When I use a GUI I use gitk or gitg to browse, history, branches, the stash etc. Those also might be linux specific tools. Also most IDEs (Android Studio, vs code, etc) have built-in git support. But this is specific to the IDE and has not much todo with using codeberg in particular (at least I think so). You could argue that the command line is also not codeberg specific, but mentioning how to work with the command line is at least a common base, which works on any OS, and the git client is the official reference client. I do not object taking screenshots and explaining things for GUI users, as long as those GUIs are free software, but certainly I am not the right person to write such an article. Maybe it would be good to at least have a small introduction on how to install the git command line client on Windows, Linux, and macOS (I assume it is shipped with git).

ivan-paleo commented 2020年09月16日 15:27:57 +02:00

think the "Git Bash" that you mention is a windows tool that bundles bash with git as a command line tool.

Indeed.

I do not object taking screenshots and explaining things for GUI users, as long as those GUIs are free software, but certainly I am not the right person to write such an article.

I don't think it is relevant to have screenshots for the Git clients (there are too many), I meant only for the Codeberg web interface (but apparently, it's not the "correct" term), even though I expect few people really use it to edit/commit.

Maybe it would be good to at least have a small introduction on how to install the git command line client on Windows, Linux, and macOS (I assume it is shipped with git).

I would agree on that! That would also make it explicit where these commands should be typed in. And this is where it would make sense to add a link to the list of Git clients on the Git website for those who would prefer using them.

> think the "Git Bash" that you mention is a windows tool that bundles bash with git as a command line tool. Indeed. > I do not object taking screenshots and explaining things for GUI users, as long as those GUIs are free software, but certainly I am not the right person to write such an article. I don't think it is relevant to have screenshots for the Git clients (there are too many), I meant only for the Codeberg web interface (but apparently, it's not the "correct" term), even though I expect few people really use it to edit/commit. > Maybe it would be good to at least have a small introduction on how to install the git command line client on Windows, Linux, and macOS (I assume it is shipped with git). I would agree on that! That would also make it explicit where these commands should be typed in. And this is where it would make sense to add a link to the list of Git clients on the Git website for those who would prefer using them.

lhinderberger commented 2020年09月16日 16:58:29 +02:00

Thank you @ivan-paleo :) I agree with you that the current articles on Git should be more accessible to a wider audience.

Let's split this up into a number of sub-issues:

• Should we recommend a Git GUI client? #65
• Write an Article on installing Git (CLI) #66
• What parts of our web interface need further documentation? #67

Thank you @ivan-paleo :) I agree with you that the current articles on Git should be more accessible to a wider audience. Let's split this up into a number of sub-issues: - Should we recommend a Git GUI client? #65 - Write an Article on installing Git (CLI) #66 - What parts of our web interface need further documentation? #67