Due to Sebastien and Daan's help, I have been able to create a pull request for a small change to the docs. https://wiki.eclipse.org/EGit/User_Guide#Working_with_remote_Repositories was also a great help. It took me a few attempts to get a push to my github repo working but it finally worked.

Eclipse/STS is pretty good for editing docs since it has an ReST editor that provides an outline for documents. I would like to have a Maven plug-in for Sphinx but I am not sure about everyone else so it might be tricky to integrate it into my workflow without affecting the master on git.

If anyone has a chance to look at the pull request and let me know if I got it right, that would be reassuring.

Ron




On 30/10/2015 5:58 AM, Sebastien Goasguen wrote:
Ron,

I don’t know how to use Github with eclipse, I use the command line for 
everything.

But the documentation should be good:
https://github.com/apache/cloudstack-docs-admin#contributing-to-the-documentation

Basically you need an account on GitHub.
You fork https://github.com/apache/cloudstack-docs-admin (or the other docs 
repo).
You will then have a fork at 
https://github.com/<YOUR_ACCOUNT>/cloudstack-docs-admin

Clone your own fork:

$ git clone https://github.com/<YOUR_ACCOUNT>/cloudstack-docs-admin

Make your commits via eclipse and push to your own fork.

Then on the GitHub UI, create a pull request to the upstream repo:
https://github.com/apache/cloudstack-docs-admin

-sebastien

On Oct 29, 2015, at 9:58 PM, Ron Wheeler <rwhee...@artifact-software.com> wrote:

Trying to help out with the docs without doing too much damage.
I am new to git.

I am using Eclipse with the egit/mylyn plug-in and I have managed to get the 
source for the docs-admin downloaded.

The "Configure Fetch" has a Source Ref of "refs/heads/*" and a Desctination Ref  of 
"refs/remotes/origin/*"
I think that I have the right sources. They seem to match the published docs.

I have made my changes and think that I need to create a pull request to get 
one of the Cloudstack gods to decide if my attempts are worthy.

I have created the pull request in Eclipse but when I try to submit it I get an error box titled "Submit 
failed" popping up with the rather cryptic "Unexpected error: Invalid request. "base", 
"head" weren't supplied".
I think that I have to configure the 
"Remotes/origin/https://gethub.com/apache/cloudstack-doc-admin.git"; entry  using 
"Configure Push" menu.

It has a section called "Ref mappings" that I gather is how git figures out how 
I want my changes mapped back into the remote repos.

Am I looking in the right places?
If so, what are the right "Source Ref" and "Destination Ref" entries to get a 
pull request that will please the gods (both local and remote).

It looks like editing and creating pull requests gets easy once this is working.

Still have to work on getting the document production working so I can actually 
see the fruits of my labour.

Thanks

Ron


*
*

--
Ron Wheeler
President
Artifact Software Inc
email: rwhee...@artifact-software.com
skype: ronaldmwheeler
phone: 866-970-2435, ext 102




--
Ron Wheeler
President
Artifact Software Inc
email: rwhee...@artifact-software.com
skype: ronaldmwheeler
phone: 866-970-2435, ext 102

Reply via email to