wiki: Move client quick install guide. #1715

JoeGruffins · 2022-07-18T09:21:25Z

wiki: Move client install guides.

wiki: Update contributing instructions.

~~Depends on #1714 atm. Depends on #1747.~~ Part of #1641.

chappjc · 2022-07-18T14:49:02Z

docs/wiki/Home.md


-`cd wiki; git remote add me https://github.com/your-username/dcrdex.wiki.git`
+```
+git push wiki `git subtree split --prefix docs/wiki HEAD`:master --force


Cool learning about subtree!

Was looking at docs for the commands and came across tihs:

push <repository> [+][<local-commit>:]<remote-ref> Does a split using the <prefix> subtree of <local-commit> and then does a git push to push the result to the <repository> and <remote-ref>. This can be used to push your subtree to different branches of the remote repository. Just as with split, if no <local-commit> is given, then HEAD is used. The optional leading + is ignored.

Sounds like git subtree push does a split and then a git push. Doesn't that make this command the same as git subtree push -f --prefix docs/wiki wiki HEAD:master (where HEAD is actually implied if omitted)?

Does -f force? Testing...

For me -f doesn't work. The subtree commands seem to be limited. So, we force push the changes to our wiki branch. Forcing because it's easiest.

The commits in the dcrdex wiki also look clean. Here they are after this pr and changes are pushed:

commit fb034729f912cc3b0e50e7705293bb2cf2407108 (HEAD -> master, origin/master, origin/HEAD) Author: JoeGruff <joegruffins@gmail.com> Date: Mon Jul 18 17:39:30 2022 +0900 wiki: Move client quick install guide. commit a30891073d7d646fe2d055e2c15b356d1580d4fe Author: JoeGruff <joegruffins@gmail.com> Date: Mon Jul 18 15:13:42 2022 +0900 wiki: Update contributing instructions. commit 3f0a68ea2897c54c64c9d859b7b7c5575fd4387e (upstream/master) Author: Jonathan Chappelow <chappjc@users.noreply.github.com> Date: Fri Jul 8 14:28:02 2022 -0500 Updated Native BTC Wallet Recovery and Rescanning (markdown)

Yes, force is cleanest - just reset the remote ref.
I figured [<options>] would get passed through to the underlying git commands (i.e. push), but clearly not.
In that case, yeah, your command looks good. Except lets use $() evaluation instead of backticks.

HEAD was not necessary so removed.

Except lets use $()

ok

Using $().

JoeGruffins · 2022-07-19T02:06:35Z

docs/wiki/Home.md

-`git clone https://github.com/decred/dcrdex.wiki.git wiki`
+```
+git remote add wiki https://github.com/your-username/dcrdex.wiki.git
+git subtree push --prefix docs/wiki wiki master


I'm assuming that wiki master does not yet exist here. I'm not sure tho... Will try to test will a different repo.

Trying on a different repo, it looks like master is created with an initial commit. So, delete master and then push.

JoeGruffins · 2022-08-01T01:14:15Z

I think I've added something wierd with commit 5571c0d +15,604 −57 fixing...

edit: fixed..

JoeGruffins · 2022-08-01T23:13:06Z

Will rebase on top of #1747

docs/wiki/Client.mediawiki

buck54321 · 2022-08-04T22:52:51Z

docs/wiki/Client.mediawiki

+===Sync Blockchains===
+
+Once installed, begin syncing your blockchains. In a new console, run
+
+<code>cd ~/decred</code>
+
+<code>./dcrd</code>
+
+Decred should sync within a couple of hours.


This is not current advice for a "quick start" guide. Let's direct them to use the native wallets instead.

You can move the RPC wallet instructions somewhere else, but I'm not sure it makes sense to try to describe Decred and Bitcoin together anymore.

Updated with #1747 so ok?

buck54321 · 2022-08-04T23:03:16Z

docs/wiki/Client.mediawiki

+'''WARNING''': If instead of using '''dcrinstall''' you decide to build from source and
+you plan to trade on mainnet, use the <code>release-v0.3</code> branch instead of <code>master</code>.
+Furthermore, if you build dcrd and dcrwallet from source, you '''must''' use their
+<code>release-v1.7</code> branches, not <code>master</code>.


release-v1.7.4 for both, right now.

This is an interesting point. The branch for all 1.7.x releases is release-v1.7 while the latest tag will be something like release-v1.7.4. I've been leaning toward release branches to avoid needing to update the docs for every release.

Using release-v1.7...

chappjc · 2022-08-04T23:16:31Z

docs/wiki/Client.mediawiki

@@ -1,4 +1,63 @@
-==Client (dexc) ==
+=Guides=


Am I the only one who seriously dislikes mediawiki? Would anything be lost by using md? I guess the nice tables for the various payloads rely on it.

BTW, what's the audience for this page? Before it was some advanced technical docs, which are still at the bottom, but now it begins with some basic setup stuff.

I hope my modifications to the README "quick start" in #1747 aren't off-base, but I feel like I've reduced it to very basics that a prospective user dropping in on the github repo would need. Namely, how to install, how to run and configure, and anything else to keep in mind.

Am I the only one who seriously dislikes mediawiki? Would anything be lost by using md? I guess the nice tables for the various payloads rely on it.

Meh.

BTW, what's the audience for this page? Before it was some advanced technical docs, which are still at the bottom, but now it begins with some basic setup stuff.

I was kind of thinking that too. The page seems to be a catchall for client stuff. I figured we can always break it up later.

I figured we can always break it up later

Sounds good. Let's just get things moving. It's just the wiki.

Do... you want to do .md? I have absolutely no preference and don't know a whole lot about either.

Ok to leave this client control mediawiki since it actually uses mediawiki stuff, but might as well keep things markdown if they are already markdown, and new pages should prefer md.

There's just no simple way to render mediawiki without deploying it to a webserver.

Newest comment just makes a new .md file.

JoeGruffins · 2022-08-05T07:36:34Z

The first comment has not changed but second one now makes a new file Client-Installation-and-Configuration.md and moves the client guides. This is just a quick and dirty move, but I think accomplishes what we want. i.e. move the client guides to the wiki.

JoeGruffins force-pushed the clientguide branch from df9c577 to 32e5178 Compare July 18, 2022 09:42

chappjc reviewed Jul 18, 2022

View reviewed changes

JoeGruffins force-pushed the clientguide branch 2 times, most recently from 7e5eaae to 1c5924f Compare July 19, 2022 01:51

JoeGruffins commented Jul 19, 2022

View reviewed changes

JoeGruffins force-pushed the clientguide branch from 1c5924f to 14bdc85 Compare July 19, 2022 02:42

JoeGruffins mentioned this pull request Aug 1, 2022

docs: Add wiki. #1714

Merged

JoeGruffins force-pushed the clientguide branch 2 times, most recently from eea8eca to de0f73f Compare August 1, 2022 03:09

JoeGruffins marked this pull request as ready for review August 1, 2022 03:11

buck54321 mentioned this pull request Aug 4, 2022

Master Issue: Documentation #1641

Closed

24 tasks

buck54321 requested changes Aug 4, 2022

View reviewed changes

chappjc reviewed Aug 4, 2022

View reviewed changes

wiki: Update contributing instructions.

6cd343e

JoeGruffins force-pushed the clientguide branch 2 times, most recently from d170789 to e239331 Compare August 5, 2022 07:17

wiki: Move client install guides.

40887e8

JoeGruffins force-pushed the clientguide branch from e239331 to 40887e8 Compare August 5, 2022 07:26

buck54321 approved these changes Aug 13, 2022

View reviewed changes

chappjc merged commit f71fd09 into decred:master Aug 13, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

wiki: Move client quick install guide. #1715

wiki: Move client quick install guide. #1715

JoeGruffins commented Jul 18, 2022 •

edited

chappjc Jul 18, 2022

JoeGruffins Jul 19, 2022

JoeGruffins Jul 19, 2022

chappjc Jul 19, 2022 •

edited

JoeGruffins Jul 19, 2022

JoeGruffins Jul 19, 2022

JoeGruffins Jul 19, 2022

JoeGruffins Jul 19, 2022

JoeGruffins commented Aug 1, 2022 •

edited

JoeGruffins commented Aug 1, 2022

buck54321 Aug 4, 2022

JoeGruffins Aug 5, 2022

buck54321 Aug 4, 2022

chappjc Aug 4, 2022

JoeGruffins Aug 5, 2022

chappjc Aug 4, 2022 •

edited

buck54321 Aug 4, 2022

chappjc Aug 4, 2022

JoeGruffins Aug 5, 2022

chappjc Aug 5, 2022 •

edited

JoeGruffins Aug 9, 2022

JoeGruffins commented Aug 5, 2022 •

edited

wiki: Move client quick install guide. #1715

wiki: Move client quick install guide. #1715

Conversation

JoeGruffins commented Jul 18, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chappjc Jul 19, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoeGruffins commented Aug 1, 2022 • edited

JoeGruffins commented Aug 1, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chappjc Aug 4, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chappjc Aug 5, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoeGruffins commented Aug 5, 2022 • edited

JoeGruffins commented Jul 18, 2022 •

edited

chappjc Jul 19, 2022 •

edited

JoeGruffins commented Aug 1, 2022 •

edited

chappjc Aug 4, 2022 •

edited

chappjc Aug 5, 2022 •

edited

JoeGruffins commented Aug 5, 2022 •

edited