[GNC-dev] Register Documentation Improvements (was Re: [GNC] Column widths again)

John Ralls jralls at ceridwen.us
Thu Aug 23 23:45:47 EDT 2018


It’s git. It’s never difficult to remove stuff, but on the website there’s no reflow to get back what you’ve deleted, so take a  little more care than usual. (Well, there is, but not from the web interface: https://medium.com/git-tips/githubs-reflog-a9ff21ff765f <https://medium.com/git-tips/githubs-reflog-a9ff21ff765f>)

You’ve already got a clone and you made a PR a week ago, so you’re most of the way there already.

{Optional} Create a branch in your repo on the website: Click on the “branch” drop down and enter a new branch name.

Now pick a file and click on the pencil. Make an edit or two. Scroll to the bottom where you’ll find two edit boxes, one for the commit summary and another for a detailed message and a radio to commit your changes or to create a new branch and a PR all in one go, which is why I marked “create a branch” as optional.

This method creates one commit per file. If your change is more complex and you want to have edits of more than one file in a single commit, there’s a work-around at https://stackoverflow.com/questions/17815895/can-i-edit-two-files-then-make-one-commit-using-github-web-based-editor <https://stackoverflow.com/questions/17815895/can-i-edit-two-files-then-make-one-commit-using-github-web-based-editor>.

When you’re done playing, just change the branch back to master and click the “# branches”  in the bar on the root page. You’ll get a list of current branches with a red trash can on the right side. Click the trash can to delete your play branch.

John Ralls

> On Aug 23, 2018, at 2:44 PM, David T. <sunfish62 at yahoo.com> wrote:
> Hmm.
> Let me see if I understand this correctly. You’re saying that I could make edits on my own forked copy of gnucash-docs, save those changes, and get them to the official gnucash-docs *all from the github website*?
> *If* I understand it correctly, then this would be a big improvement from my perspective. After all, I’ve never objected to adding the obscure codes; it’s always been getting the changes in. It does sound promising, but I hesitate to take it on, simply because at this point, I am a trained hamster who knows how to get a result in one way and one way only. 
> I will look for a simple doc update to try it out on; that way, when I miraculously find the one way to screw it up, it won’t be difficult to remove.
> David
>> On Aug 23, 2018, at 9:55 AM, John Ralls <jralls at ceridwen.us> wrote:
>>> On Aug 23, 2018, at 6:37 AM, Geert Janssens <geert.gnucash at kobaltwit.be> wrote:
>>> Op donderdag 23 augustus 2018 15:08:54 CEST schreef Derek Atkins:
>>>> Geert Janssens <geert.gnucash at kobaltwit.be> writes:
>>>> [snip]
>>>>> So I'm open for alternatives that would equally handle version
>>>>> control, but is easier for documentation writers to cope with.
>>>>> This can be a completely different tool that feels more intuitive or
>>>>> it can be a system layered on top of git which would hide git's
>>>>> technicalities. For example a web interface that offers online
>>>>> documentation editing and that behind the scenes stores changes in
>>>>> git. I don't know of such project off-hand though, but it may be worth
>>>>> looking around for.
>>>>> Those who need more advanced access can clone the git repo and work
>>>>> locally.
>>>> I wonder how hard it would be to write a web interface on top of git
>>>> that abstracts away most of the git work to enable easier access?
>>>> -derek
>>> It looks like gitlab does something like this already...
>>> At least on Gnome's gitlab there are buttons to edit or open a webide. They 
>>> only work on pages you have write access of course. However you can always 
>>> fork a repo to get one with write access.
>> So does GitHub (it’s the pencil icon to the right of Raw/Blame/History), which also has a desktop front-end, https://desktop.github.com/ <https://desktop.github.com/> and a button on a file’s webpage that opens the file in Github Desktop.
>> I haven’t tried any of them, but perhaps David T. might like to and give us a non-developer perspective.
>> Regards,
>> John Ralls
>> _______________________________________________
>> gnucash-devel mailing list
>> gnucash-devel at gnucash.org
>> https://lists.gnucash.org/mailman/listinfo/gnucash-devel

More information about the gnucash-devel mailing list