<div dir="ltr"><div><div>Hi,. <br></div></div><br>2016-06-04 7:25 GMT+02:00 Angie Garcia <span dir="ltr"><<a href="mailto:amg832@outlook.com" target="_blank">amg832@outlook.com</a>></span>:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">To
move forward with editing documentation, I have created a sample of how
the User Guide 2.14 could be modified. Keep in mind this is only one
idea, all input is welcomed.<br></blockquote><div><br>Looking forward to
reading this doc. No worry we are open to changes as far as they
improve the project are sustainable and worth the effort<br><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
All changes were indicated with red font, I made changes up to end of
chapter 1. Need to upload pdf to repository. Can someone provide best
way to do this? I have created my GitHub account and fork (created copy
of repository), installed the Git, but not created the local
repository.<br>
<br></blockquote><div>Actually, from my experience, having a local
repository is not that mandatory (except to keep uptodate your _master_
branch). I only needed it because:<br>- I wanted a clean history: I couldn't do all my changes in one go so needed to use git commands to merge them in one change (<i>commit</i>)<br>- I had to manage conflicts between my proposal (<i>pull request</i>) and changes done to the repo by others meanwhile<br>-
and to have branch(es) that follow official master branch, (purists
could say this is mandatory - but you can workaround thanks to GitHub
web interface)<br><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
I worked on document aesthetics, content, consistency and followed along
using QGIS software. However, if a re-design change is made to the
document, it would be a good idea to update other manuals.<br>
<br></blockquote><div>consistency, improvement, sustainability, new ideas are all welcome...<br> <br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
The idea will be to edit one section/chapter at a time then upload it to the repository.<br></blockquote><div> </div><div>I think a more sustainable process would be using github
directly to perform your changes so
let's do a step by step modification, now that you have a github
account. Let's say you'll like to fix things in the "Getting Started"
chapter
(<a href="http://docs.qgis.org/testing/en/docs/user_manual/introduction/getting_started.html" target="_blank">http://docs.qgis.org/testing/en/docs/user_manual/introduction/getting_started.html</a>):<br><br><div>1. Click the "Fix Me" link at the bottom of the page<br>2.
this would open
<a href="https://github.com/qgis/QGIS-Documentation/edit/master/source/docs/user_manual/introduction/getting_started.rst" target="_blank">https://github.com/qgis/QGIS-Documentation/edit/master/source/docs/user_manual/introduction/getting_started.rst</a>.
A message at the top of the page will tell you that you don't have
write access to this repo and your changes will be applied in a branch
of your forked repo.<br></div><div> 2b. If your master branch is even
with qgis/master, you can replace the link above by yours
<a href="https://github.com/amg832/QGIS-Documentation/edit/master/source/docs/user_manual/introduction/getting_started.rst" target="_blank">https://github.com/amg832/QGIS-Documentation/edit/master/source/docs/user_manual/introduction/getting_started.rst</a></div><div>3. following guidelines available at <a href="http://docs.qgis.org/testing/en/docs/documentation_guidelines/" target="_blank">http://docs.qgis.org/testing/en/docs/documentation_guidelines/</a>, do your changes<br></div><div>4.
When you finish, at the bottom of the page, comment a bit what your
changes are about and click on "Propose File change". This will generate
a new branch (<i>patch-xxx</i> - i can't recall if you can name the branch) in your repo<br></div><div>
4b. If you use your own master branch (as said in 2b), you're strongly
advised to commit in a new branch with a remindable name (let's use
getStart). Avoid committing your changes in the master branch. Actually,
it's good to have a branch even with the main project and master is
usually used for that. Keep it just to merge qgis/master changes inside,
not yours.<br></div><div>Now you have a file in
<a href="https://github.com/amg832/QGIS-Documentation/patch-1/source/docs/user_manual/introduction/getting_started.rst" target="_blank">https://github.com/amg832/QGIS-Documentation/patch-1/source/docs/user_manual/introduction/getting_started.rst</a>
(or
<a href="https://github.com/amg832/QGIS-Documentation/getStart/source/docs/user_manual/introduction/getting_started.rst" target="_blank">https://github.com/amg832/QGIS-Documentation/getStart/source/docs/user_manual/introduction/getting_started.rst</a>
if 2b) different from the official doc with your changes. Now you need
to inform about your changes and ask for merging (pull request to the
main repo).<br></div><div>5. You get a "Comparing changes" page. Ensure that the base fork is <i>qgis/QGIS-Documentation</i> and its branch <i>master </i><br></div><div>6. Click on "Create pull request", fill some info if needed and apply<br></div><div>7.
A new PR is added to <a href="https://github.com/qgis/QGIS-Documentation/pulls" target="_blank">https://github.com/qgis/QGIS-Documentation/pulls</a>
and every body can look or comment it (under files tab). <br>8. And a repo maintainer can merge your work directly with the official doc if all is ok in one-click.<br></div><div>9.
Until your PR is merged with the repo, you can add modifications to
your proposal. Actually any new changes done to your branch patch-xxx
(or getStart) is appended to your PR. Do it if the change has to do with
your initial pull request, otherwise create a new branch with those
changes following steps above.<br><br></div>Sorry for my long message if you already knew all this. There are other ways to do it but this one looked straight for me when I began contributing. Hope that it's useful to someone.<br> <br></div><div>Regards,<br></div>Harrissou<div class="gmail_extra"><br><div class="gmail_quote">2016-06-04 10:03 GMT+02:00 Alexandre Neto <span dir="ltr"><<a href="mailto:senhor.neto@gmail.com" target="_blank">senhor.neto@gmail.com</a>></span>:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><p dir="ltr">If you wanna share a PDF you could put it in Dropbox or something similar. The repository is not the place for it.</p><div><div>
<br><div class="gmail_quote"><div dir="ltr">A sáb, 4/06/2016, 06:30, Angie Garcia <<a href="mailto:amg832@outlook.com" target="_blank">amg832@outlook.com</a>> escreveu:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">To move forward with editing documentation, I have created a sample of how the User Guide 2.14 could be modified. Keep in mind this is only one idea, all input is welcomed.<br>
<br>
All changes were indicated with red font, I made changes up to end of chapter 1. Need to upload pdf to repository. Can someone provide best way to do this? I have created my GitHub account and fork (created copy of repository), installed the Git, but not created the local repository.<br>
<br>
I worked on document aesthetics, content, consistency and followed along using QGIS software. However, if a re-design change is made to the document, it would be a good idea to update other manuals.<br>
<br>
The idea will be to edit one section/chapter at a time then upload it to the repository.<br>
<br>
Best Regards,<br>
Angie<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
________________________________________<br>
From: Qgis-community-team <<a href="mailto:qgis-community-team-bounces@lists.osgeo.org" target="_blank">qgis-community-team-bounces@lists.osgeo.org</a>> on behalf of Yves Jacolin <<a href="mailto:yjacolin@free.fr" target="_blank">yjacolin@free.fr</a>><br>
Sent: Thursday, June 2, 2016 5:17:40 AM<br>
To: <a href="mailto:qgis-community-team@lists.osgeo.org" target="_blank">qgis-community-team@lists.osgeo.org</a><br>
Subject: Re: [Qgis-community-team] New QGIS Documentation Subscriber<br>
<br>
Hello,<br>
<br>
A good start for an english native speaker could be:<br>
* make review of Pull request<br>
* proof read the doc to see english error, etc. and create issue with the<br>
correct sentence.<br>
<br>
That would be a really huge enhancement, but also a hard work.<br>
<br>
Y.<br>
<br>
<br>
On Thursday, June 02, 2016 1:20:25 DelazJ wrote:<br>
> Hi,<br>
><br>
> Welcome Angie and thanks for offering your help!<br>
><br>
> As already pointed out by Richard you'll find few recommendations to follow<br>
> when contributing to QGIS Documentation writing at<br>
> <a href="http://docs.qgis.org/testing/en/docs/documentation_guidelines/" rel="noreferrer" target="_blank">http://docs.qgis.org/testing/en/docs/documentation_guidelines/</a><br>
> But prior to this, In order to contribute, you'll need as stated at<br>
> <a href="http://qgis.org/en/site/getinvolved/document.html#becoming-a-documenter" rel="noreferrer" target="_blank">http://qgis.org/en/site/getinvolved/document.html#becoming-a-documenter</a> to:<br>
> - create a GitHub account<br>
> - and fork (copy) the doc repo<br>
><br>
> Once done, feel free to pick any issue in the list and write about. You can<br>
> also go through the doc being written (<a href="http://docs.qgis.org/testing/en/docs" rel="noreferrer" target="_blank">docs.qgis.org/testing/en/docs</a>) and<br>
> fix potential typo errors, "bad english" (most of us are not native<br>
> speaker) or review/comment contributions of others (<br>
> <a href="https://github.com/qgis/QGIS-Documentation/pulls" rel="noreferrer" target="_blank">https://github.com/qgis/QGIS-Documentation/pulls</a>).<br>
><br>
> Once again, welcome to you and if something is unclear, just ask. Someone<br>
> will try to explain to you.<br>
><br>
> Regards,<br>
> Harrissou<br>
><br>
> 2016-06-02 0:17 GMT+02:00 Alexandre Neto <<a href="mailto:senhor.neto@gmail.com" target="_blank">senhor.neto@gmail.com</a>>:<br>
> > Angie,<br>
> ><br>
> > Welcome to the team. Thanks you for helping us with the docs.<br>
> ><br>
> > I normally do the screenshots, so anything you need, let me know. Are you<br>
> > on github already?<br>
> ><br>
> > Alexandre Beto<br>
> ><br>
> > A qua, 1/06/2016, 22:50, Angie Garcia <<a href="mailto:amg832@outlook.com" target="_blank">amg832@outlook.com</a>> escreveu:<br>
> >> Richard,<br>
> >><br>
> >> English is my primary language. Read QGIS is natively developed in<br>
> >> English, if you need assistance in looking at text before pulling it into<br>
> >> the docs, glad to help just need to know what needs to be done.<br>
> >><br>
> >> Best Regards,<br>
> >> Angie<br>
> >><br>
> >><br>
> >> ________________________________________<br>
> >> From: Richard Duivenvoorde <<a href="mailto:rdmailings@duif.net" target="_blank">rdmailings@duif.net</a>><br>
> >> Sent: Tuesday, May 31, 2016 11:53:43 PM<br>
> >> To: Angie Garcia<br>
> >> Cc: <a href="mailto:dassau@gbd-consult.de" target="_blank">dassau@gbd-consult.de</a>; Junior Delaz; Yves Jacolin; qgis-community<br>
> >> Subject: Re: New QGIS Documentation Subscriber<br>
> >><br>
> >> On 31-05-16 22:33, Angie Garcia wrote:<br>
> >> > Hi Richard,<br>
> >> ><br>
> >> > I have recently subscribed and would like to participate with updating<br>
> >> > User Guide and assist in suggestions to aid in the documentation work<br>
> >> > flow. In going through all online/materials, it mentioned that one<br>
> >> > should contact team lead in specific area of interest to get some<br>
> >> > assistance in the process. I have cc Otto as he was the person I sent<br>
> >> > email to, however, have not heard from him and thought you might be<br>
> >> > able<br>
> >> > to help me or point me in the right direction to move forward.<br>
> >> ><br>
> >> > Is there a new welcoming documentation packet which helps one get<br>
> >> > setup,<br>
> >> > have a mailing list of individuals to contact, talks a little about the<br>
> >> > various emails and limitations, etc...<br>
> >><br>
> >> Hi Angie,<br>
> >><br>
> >> For what I know this:<br>
> >><br>
> >> <a href="http://docs.qgis.org/testing/en/docs/documentation_guidelines/" rel="noreferrer" target="_blank">http://docs.qgis.org/testing/en/docs/documentation_guidelines/</a><br>
> >><br>
> >> are the guidelines. In the README at:<br>
> >><br>
> >> <a href="https://github.com/qgis/QGIS-Documentation" rel="noreferrer" target="_blank">https://github.com/qgis/QGIS-Documentation</a><br>
> >><br>
> >> is more information about how to actually BUILD the docs.<br>
> >><br>
> >> Note that it is actually not persee nessecary to build it yourself. If<br>
> >> you follow the 'fix me' link in the footer of the pages on current<br>
> >> 'testing' (==2.14 to be) version:<br>
> >><br>
> >> <a href="http://docs.qgis.org/testing/en/docs/user_manual/index.html" rel="noreferrer" target="_blank">http://docs.qgis.org/testing/en/docs/user_manual/index.html</a><br>
> >><br>
> >> you can write/fix smaller parts of the docs in Github.<br>
> >><br>
> >> I added Harrisou and Yves in cc, they have been mostly active I think<br>
> >> recently, and maybe can give you a hand too.<br>
> >> I will also sent this email to the community list where most document<br>
> >> writers hang out.<br>
> >><br>
> >> Here:<br>
> >><br>
> >> <a href="https://github.com/qgis/QGIS-Documentation/issues" rel="noreferrer" target="_blank">https://github.com/qgis/QGIS-Documentation/issues</a><br>
> >> all issues labeld QGIS 2.14<br>
> >> <a href="https://github.com/qgis/QGIS-Documentation/milestones/QGIS%202.14" rel="noreferrer" target="_blank">https://github.com/qgis/QGIS-Documentation/milestones/QGIS%202.14</a><br>
> >> should be taken up in short notice.<br>
> >> Not sure if you are native speaker, but we also look for native speakers<br>
> >> to have a look at texts of others before pulling into the docs.<br>
> >><br>
> >> Pick an issue, try something, ask... just DO it ;-)<br>
> >><br>
> >> Regards,<br>
> >><br>
> >> Richard Duivenvoorde<br>
> >><br>
> >> ps reaching me in private is best done via richard@qgis.org... Using the<br>
> >> rdmailings you end up in the big pile of mailinglists I have :-)<br>
> >> BUT I prefer communicating through mailing lists as more people learn<br>
> >> from this.<br>
> >><br>
> >> _______________________________________________<br>
> >> Qgis-community-team mailing list for organizing community resources such<br>
> >> as documentation, translation etc..<br>
> >> <a href="mailto:Qgis-community-team@lists.osgeo.org" target="_blank">Qgis-community-team@lists.osgeo.org</a><br>
> >> <a href="http://lists.osgeo.org/mailman/listinfo/qgis-community-team" rel="noreferrer" target="_blank">http://lists.osgeo.org/mailman/listinfo/qgis-community-team</a><br>
> ><br>
> > --<br>
> > Alexandre Neto<br>
> > ---------------------<br>
> > @AlexNetoGeo<br>
> > <a href="http://sigsemgrilhetas.wordpress.com" rel="noreferrer" target="_blank">http://sigsemgrilhetas.wordpress.com</a><br>
> > <a href="http://gisunchained.wordpress.com" rel="noreferrer" target="_blank">http://gisunchained.wordpress.com</a><br>
> ><br>
> > _______________________________________________<br>
> > Qgis-community-team mailing list for organizing community resources such<br>
> > as documentation, translation etc..<br>
> > <a href="mailto:Qgis-community-team@lists.osgeo.org" target="_blank">Qgis-community-team@lists.osgeo.org</a><br>
> > <a href="http://lists.osgeo.org/mailman/listinfo/qgis-community-team" rel="noreferrer" target="_blank">http://lists.osgeo.org/mailman/listinfo/qgis-community-team</a><br>
<br>
_______________________________________________<br>
Qgis-community-team mailing list for organizing community resources such as documentation, translation etc..<br>
<a href="mailto:Qgis-community-team@lists.osgeo.org" target="_blank">Qgis-community-team@lists.osgeo.org</a><br>
<a href="http://lists.osgeo.org/mailman/listinfo/qgis-community-team" rel="noreferrer" target="_blank">http://lists.osgeo.org/mailman/listinfo/qgis-community-team</a><br>
_______________________________________________<br>
Qgis-community-team mailing list for organizing community resources such as documentation, translation etc..<br>
<a href="mailto:Qgis-community-team@lists.osgeo.org" target="_blank">Qgis-community-team@lists.osgeo.org</a><br>
<a href="http://lists.osgeo.org/mailman/listinfo/qgis-community-team" rel="noreferrer" target="_blank">http://lists.osgeo.org/mailman/listinfo/qgis-community-team</a></blockquote></div><div dir="ltr">-- <br></div><div data-smartmail="gmail_signature"><div dir="ltr"><div>Alexandre Neto</div><div>---------------------</div><div>@AlexNetoGeo</div><div><a href="http://sigsemgrilhetas.wordpress.com" target="_blank">http://sigsemgrilhetas.wordpress.com</a></div><a href="http://gisunchained.wordpress.com" target="_blank">http://gisunchained.wordpress.com</a><br></div></div>
</div></div><br>_______________________________________________<br>
Qgis-community-team mailing list for organizing community resources such as documentation, translation etc..<br>
<a href="mailto:Qgis-community-team@lists.osgeo.org" target="_blank">Qgis-community-team@lists.osgeo.org</a><br>
<a href="http://lists.osgeo.org/mailman/listinfo/qgis-community-team" rel="noreferrer" target="_blank">http://lists.osgeo.org/mailman/listinfo/qgis-community-team</a><br></blockquote></div><br></div></div>