df8oe / UHSDR

SDR firmware and bootloader with configuration files for use with Eclipse, EmBitz and Makefile
Other
360 stars 189 forks source link

update for Wiki #1838

Open csylvain opened 4 years ago

csylvain commented 4 years ago

i have made the UHSDR wiki use visual media stored within it's own repo (for maintainability) and have incorporated material from EA3HZZ which provides connector pinout information in the new "mcHF Connections" page.

i would have submitted this update as a pull request, except github does not offer than for a wiki subordinate to a code repo.

to update the df8oe/UHSDR.wiki it will be necessary to clone https://github.com/csylvain/UHSDR.wiki.git locally, then push to df8oe/UHSDR.wiki

df8oe commented 4 years ago

The idea to put WIKI images in repo is a nice one. Before cloning the WIKI and pushing it I must investigate how to see the changes - I never have done such a work on WIKI ;)

csylvain commented 4 years ago

what you will get is what is in my wiki's repo right now. git pull your own wiki, then git pull my wiki, then copy everything from mine on top of your local copy of your wiki. then you can work git like normal in your wiki's copy.

On Tue, Mar 3, 2020 at 3:10 PM DF8OE notifications@github.com wrote:

The idea to put WIKI images in repo is a nice one. Before cloning the WIKI and pushing it I must investigate how to see the changes - I never have done such a work on WIKI ;)

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/df8oe/UHSDR/issues/1838?email_source=notifications&email_token=ABRUYNLFKVANCXD2ZZVBJMLRFVP3TA5CNFSM4LARQCQKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENU64GI#issuecomment-594144793, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABRUYNLO45J2SU3DIJHXSWLRFVP3TANCNFSM4LARQCQA .

csylvain commented 4 years ago

sorry "git clone" not "git pull" :-P

On Tue, Mar 3, 2020 at 4:32 PM Christopher Sylvain chris.sylvain@gmail.com wrote:

what you will get is what is in my wiki's repo right now. git pull your own wiki, then git pull my wiki, then copy everything from mine on top of your local copy of your wiki. then you can work git like normal in your wiki's copy.

On Tue, Mar 3, 2020 at 3:10 PM DF8OE notifications@github.com wrote:

The idea to put WIKI images in repo is a nice one. Before cloning the WIKI and pushing it I must investigate how to see the changes - I never have done such a work on WIKI ;)

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/df8oe/UHSDR/issues/1838?email_source=notifications&email_token=ABRUYNLFKVANCXD2ZZVBJMLRFVP3TA5CNFSM4LARQCQKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENU64GI#issuecomment-594144793, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABRUYNLO45J2SU3DIJHXSWLRFVP3TANCNFSM4LARQCQA .

df8oe commented 4 years ago

I am nearly sure there is a simple way to see the diffs like in "normal git". But this week I am very busy and so I will start this at the weekend. And of course I will publish my "way".

csylvain commented 4 years ago

if we could fork a wiki just the same as a code repo, then it would be really simple. unfortunately, in github world, wiki is still a different kind of repo than a code repo. i do know if you cloned them both locally and just overwrote the cloned original content files with the new content files, then you'd be able to see the changes in a normal way like you had done it all yourself. then you need only choose to commit or revert or edit further ...

On Wed, Mar 4, 2020 at 1:57 AM DF8OE notifications@github.com wrote:

I am nearly sure there is a simple way to see the diffs like in "normal git". But this week I am very busy and so I will start this at the weekend. And of course I will publish my "way".

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/df8oe/UHSDR/issues/1838?email_source=notifications&email_token=ABRUYNJAC3OAEOMGVBRICGLRFX3WXA5CNFSM4LARQCQKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENWTAQY#issuecomment-594358339, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABRUYNIMN332RWWGCFDP2ZDRFX3WXANCNFSM4LARQCQA .

df8oe commented 4 years ago

Hi, I have got it work but I am not sure everything is "as expected"... Firstly I have got information that wiki can be handled same as code area. So I added an upstream: git remote add upstream https://github.com/csylvain/UHSDR.wiki.git Next I fetched the contents: git fetch upstream and merged it into my local copy: git merge upstream/master No errors popped up - and there was a new folder created in wiki: images... Now I tested locally if everything works and it did. So I pushed it with: git push Only thing where I am not clear: The folder containing the images now is located within wiki area. I do not think taht is soooo bad: it IS wiki contents, and if it can be handled with standard git commands: why not? You can maintain it easily via git...

csylvain commented 4 years ago

what i mean by the wiki repo not being exactly the same as a code repo is you do not have the option to work with it the same way via a web browser at github.com. there also is not the same mechanism for creating a pull request via a browser at github.com. yes, as long as you use the 'magic' wiki repo URL, then you can manipulate repos on your local drive like normal. for now, you must rely on your local storage to work with wiki repos where github makes it more easy when working with a code repo.

also, until recently, and according to some people who wrote about developing a github wiki, 'magic' URLs were needed in the Markdown code to reference binary blobs like images. fortunately, there is now some simple MediaWiki code which can be written.

it is certainly desirable and recommended to store wiki media within the wiki itself. there is always a risk of media being unavailable when referencing media external to github when github is the host of the wiki.

i hope we are both now in complete understanding of each other.

On Fri, Mar 6, 2020 at 5:00 AM DF8OE notifications@github.com wrote:

Hi, I have got it work but I am not sure everything is "as expected"... Firstly I have got information that wiki can be handled same as code area. So I added an upstream: git remote add upstream https://github.com/csylvain/UHSDR.wiki.git Next I fetched the contents: git fetch upstream and merged it into my local copy: git merge upstream/master No errors popped up - and there was a new folder created in wiki: images... Now I tested locally if everything works and it did. So I pushed it with: git push Only thing where I am not clear: The folder containing the images now is located within wiki area. I do not think taht is soooo bad: it IS wiki contents, and if it can be handled with standard git commands: why not? You can maintain it easily via git...

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/df8oe/UHSDR/issues/1838?email_source=notifications&email_token=ABRUYNO7PE44CWRFQSW6DNDRGDCSRA5CNFSM4LARQCQKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEOAZBUY#issuecomment-595693779, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABRUYNMBJNJPOCX5DNACDCTRGDCSRANCNFSM4LARQCQA .