Best way to fix typos in documentation: source edit + git push?

Asked by Gael Lorieul

Hi all!

I've found a few typos by reading the doc: what is the best way to fix them? Would it be ok if I fix them myself in the source code and git push it? (let's say that it could be a first baby step in contributing to Yade)

Thanks for putting together this great piece of software! ;)

Gaël

Question information

Language:
English Edit question
Status:
Expired
For:
Yade Edit question
Assignee:
No assignee Edit question
Last query:
Last reply:
Revision history for this message
Robert Caulk (rcaulk) said :
#1

Yes, absolutely :-). Yade recently migrated to gitlab where developers push to branches and then "merge request" those branches into Yade. Other developers review the merge request and then accept it if it looks OK. Details of how to do this can be found here [1].

[1]https://yade-dev.gitlab.io/trunk/github.html#pushing-changes-to-remote-repository

Revision history for this message
Gael Lorieul (glorieul64) said :
#2

Hi,

At last I am submitting the typo fixes in the documentation that I
promised some time ago already… 😅 Following the documentation [1], I am
sending it as a patch file attached to the present e-mail. [2]

It's not much, but hopefully it's just a start 😉

Cheers,

Gaël

PS: perhaps I should be using the yade-dev mailing for such
communication? If so I assume all I have to do is send an e-mail to the
list? Unlike the yade-users mailing list where it is required to ask
questions from the Launchpad interface?

[1]
https://yade-dev.gitlab.io/trunk/github.html#pushing-changes-to-remote-repository

[2]
The documentation presents three methods:
  1. Merge request from new branch in Yade repository. Requires me to be
a member, which I am not.
  2. Merge request from a repository of my own. Requires to have "group
runners", which I don't think I have. Also GitLab does not allow me to
create a merge request to `yade-dev/trunk` from either the
`yade-dev/trunk` page (no "Add merge request" item in the "+" menu), nor
from the "+" menu of my own branch (which does have an "Add merge
request" item, but does not let me select "yade-dev/trunk" as destination.
  3. Send git patch by e-mail: that's what I am doing 😉

Revision history for this message
Bruno Chareyre (bruno-chareyre) said :
#3

Hi Gaël,
Thanks vey much for contributing.
Yes you can write emails to yade-dev.
It would be very helpful if you could try method [1] (gitlab), especially if you plan to change more later, and it should not be a big deal.
Assuming you are working on source code pulled from the gitlab repository (else send use the result of "git remote -v"):

cd trunk
git status #list which files you have modified
git commit file1 file2 file3 #the files you changed
git pull --rebase
git push origin master:fixtypo

Here "fixtypo" is the name of the new branch that will be created.

Bruno

Revision history for this message
Janek Kozicki (cosurgi) said :
#4

> 2. Merge request from a repository of my own. Requires to have "group
runners"

I can help with that. Please give me the registration token for your runners. I will add a runner for you. See https://gitlab.com/yade-dev/trunk/merge_requests/112

You also need to add a tag "fast" after I add this runner for you.

Revision history for this message
Janek Kozicki (cosurgi) said :
#5

Oh good. Now you are part of yade-dev team. Welcome :) You will push to a branch on gitlab and make merge requests.

Along the way you will see what gilab-runners are doing, when you will click on a 'pipeline' on your first MR.

Revision history for this message
Janek Kozicki (cosurgi) said :
#6

Solution 2. is for people who prefer to have "group runners" we can provide that.

Revision history for this message
Gael Lorieul (glorieul64) said :
#7

Hi all!

On Fri, 3 May 2019 at 23:58, Gael Lorieul
 > First of all, Bruno Chareyre asked me for my GitLab.com user name,
 > [...] So I assume he was considering adding me to the list of team
 > members, possibly with reduced permissions?

El 03-05-19 a las 18:20, Bruno Chareyre escribió:
 > Done, sorry for delay!

El 06-05-19 a las 10:46, Janek Kozicki escribió:
 > Oh good. Now you are part of yade-dev team. Welcome:)
 > You will push to a branch on gitlab and make merge requests.

Awesome, thanks!
I will push something small soon to test all works as it should ;)

El 03-05-19 a las 18:20, Bruno Chareyre escribió:>
 > Please note that you sent reply to yade-users, feel free to use
 > yade-dev for any communication.

I will do so for future conversations, I just wanted to avoid a mess
where the present conversation would be half in yade-users and half in
yade-dev ;) .
Now I think the thread has reached to an end (hopefully, if all works as
expected… XD ), so it does not matter very much anymore.

 > Are you french? Your name sounds so.

I am ;) but living on the other side of the planet for now!

Many thanks for your help!

Gaël

Revision history for this message
Launchpad Janitor (janitor) said :
#8

This question was expired because it remained in the 'Open' state without activity for the last 15 days.