-

via

Tue, 19 Mar 2019 08:45:25 +0000

!zotlabs.org | Contribute
I would like to help working on the documentation, and eventually help with the German translation, but I need help getting started.

I figured out which files to edit locally. I made two local changes two /doc/admin/administrator_guide.md, both based on @Mario Vavti's announcement of the 4.0 release:

I changed the minimum PHP version to 7.1
I changed the section about SSL from being the recommended option to being a requirement

I then ran util/importdoc, and the changes are now live on my site at https://hub.lazyteddy.eu/help/admin/administrator_guide .

Now, how do I get those changes up for review? My experience with git is limited to git clone ... and git pull, basically.

Does anybody know a good, basic getting started guide for git?

show all 17 Comments

Harald Eilertsen

Tue, 19 Mar 2019 09:06:05 +0000

The "Getting Started" chapter of the git book is a good place to start.

Tue, 19 Mar 2019 10:23:25 +0000

@Harald Eilertsen Thanks, checking it out!

hEARt PhoniX

Tue, 19 Mar 2019 19:20:57 +0000

Hello Tanja, do you already have got a framagit account and forked core? I guess so.

I had made a mistake some time ago so I am now trying it this way. If this is correct we can update https://zotlabs.org/help/en-au/git_for_non_developers
(not linked in the interface!)

git clone https://framagit.org/h-ear-t/core
git checkout dev
git pull
git remote add upstream https://framagit.org/hubzilla/core/
git fetch upstream
git merge upstream/dev

Then you can write away. I have now tried working with a ~/.gitconfig file

cat .gitconfig                                                           [user]                                                                         
name = your name                                                            
email = em@ai.l

then

git add .
git commit -m "this is my commit description"
git push

And then create a merge request for upstream from that commit at framagit. I cannot describe that at this point.

Tue, 19 Mar 2019 19:25:02 +0000 last edited: Tue, 19 Mar 2019 19:27:48 +0000

@h.EAR.t Yes, I already created a framagit account, but that's as far as I got. After that, you lost me... Like I said, I don't have the slightest idea how git works. I took a quick glance at the link provided by @Harald Eilertsen, but I didn't have time to go through it yet, too much else to do today.

Tue, 19 Mar 2019 19:27:16 +0000

On a different note, links to specific sections of the documentation for me always go to /help/en/about/about, is this just me? This includes the link you just posted.

Oliver

Tue, 19 Mar 2019 19:29:41 +0000

/h-ear-t/core

Tue, 19 Mar 2019 19:31:19 +0000

Ooops, I must really be too tired for this - too much computering today. I missed the "expand" link

Harald Eilertsen

Tue, 19 Mar 2019 19:37:21 +0000

@h.EAR.t

git add .
 git commit -m "this is my commit description"
 git push

Only do that if you know that you want to commit all changes in the working tree as one commit. Often that is exactly what you want, in which case you can shorten it to git commit -a -m "my commit message" followed by a git push when you're ready. (You can push more than one commit at once.)

Sometimes you may want to only commit certain changes, and sometimes you may want to give a more elaborate explanation than what is practical with -m directly on the command line. The intro from the git book, will help you understand how.

hEARt PhoniX

Tue, 19 Mar 2019 19:50:02 +0000

Yes, @Harald Eilertsen sorry, it was just a record of what I just did. I have created a dedicated repo on my phone just for this purpuse, i.e. no config files etc.
That shorthand is nice. :)

@Oliver LooL did not notice that! Awesome.

@Tanja
I know it's a bit strange at first. I am a very basic git user as of now, this is kind of all I know so far. Got a book lying around, but ... :)
Take your time. As of now my impression is that I succeeded in committing the merge request.
https://framagit.org/hubzilla/core/merge_requests
Select the commit you want to merge from your request and I have been told it's important to merge it into hubzilla/core/dev because ... well, I think it's obvious. :)
Read the doco and follow my commands. The doco's commands are missing some parts which I have added and if all goes well will add to that file and post another merge request.

hEARt PhoniX

Tue, 19 Mar 2019 19:56:37 +0000

You can also send your work to the devs directly, or me if you want.
I will revamp the git howto for sure, that's important, not only for this group here. :)

Harald Eilertsen

Thu, 21 Mar 2019 20:04:58 +0000

Another good resource is the Disroot Howto about Git. The Disroot howto about Hubzilla is also worth a look!

Fri, 22 Mar 2019 05:54:56 +0000

@Harald Eilertsen Oh, this is great, more like a quick start guide. Thanks!

Robert Kormann

Sat, 14 Dec 2019 15:36:13 +0000

@Tanja I just stumbled over this request, after spending a few hours of »rainy season« in Germany translating some rettings and apps elements in German. The according hmessages.po/hstrings.php is - hopefully - under way to core/dev by email merge request. Let's see...

I see it a bit the same way: There are skilled programmers doing all the hard stuff, but Hubzilla is lacking of something like a UX team. There is a lot of information around, however, it needs to be polished, sorted and translated. For new members to come in, the saying »You never get a second chance for a first impression« is painfully true.

Sat, 14 Dec 2019 21:27:21 +0000

@Tanja

On a different note, links to specific sections of the documentation for me always go to /help/en/about/about, is this just me? This includes the link you just posted.

Same for me.

Ooops, I must really be too tired for this - too much computering today. I missed the "expand" link

What do you mean by expand link?

hEARt PhoniX

Sun, 15 Dec 2019 08:51:46 +0000

When a post is too long a part of it is hidden. Click Expand to show it all.

Sun, 15 Dec 2019 09:25:45 +0000

@Emanuel I found the solution for the deeplink issue by now. This post has been a while ago

Just remove the language part, e.g.
https://hub.lazyteddy.eu/help/member/bbcode

Instead of
https://hub.lazyteddy.eu/help/en/member/bbcode

Mon, 16 Dec 2019 14:39:11 +0000

@Tanja Danke!