') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); Split private key management section into more pages by GBKS · Pull Request #283 · BitcoinDesign/Guide · GitHub
Skip to content

Split private key management section into more pages - #283

Merged
GBKS merged 3 commits into
masterfrom
feature/pkm-section-split
May 12, 2021
Merged

Split private key management section into more pages#283
GBKS merged 3 commits into
masterfrom
feature/pkm-section-split

Conversation

@GBKS

@GBKSGBKS commented May 5, 2021

Copy link
Copy Markdown
Contributor

One page per scheme instead of one page for personal and one page for shared schemes. For #280.

@GBKS
Split private key management section into more pages
e138790
One page per scheme instead of one page for personal and one page for shared schemes. For #280.
@GBKSGBKS added the Copy Task is about improving text. label May 5, 2021
@GBKSGBKS self-assigned this May 5, 2021
@GBKSGBKS linked an issue May 5, 2021 that may be closed by this pull request
Restructure private key management pages #280
Closed
@GBKSGBKS mentioned this pull request May 5, 2021
Closed
@pavlenexpavlenex mentioned this pull request May 6, 2021
Closed
@danielnordh

danielnordh commented May 7, 2021

Copy link
Copy Markdown
Contributor

Can tackle this once #210 is merged.

@GBKS
GBKS marked this pull request as ready for review May 10, 2021 06:26
johnsBeharry
johnsBeharry previously approved these changes May 10, 2021
View reviewed changes

@johnsBeharryjohnsBeharry left a comment •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As it stands this seems like a fine update to push out now while #210 is in the works... but... It is going to get messy for @danielnordh so the question is who will be the one to deal with the merge conflicts that will arise.

@GBKS
Addressing changes from#305
4c0cb20
In which Daniel added the Bitcoin backups page and tweaked a couple of things:
- Link at the end of the "Shared multi-key" page
- Copy in the "Manual backup" page that references the Bitcoin backups page
@GBKS

GBKS commented May 11, 2021

Copy link
Copy Markdown
ContributorAuthor

As #210 / #305 with the new Bitcoin backups page was just merged, I pushed an update to account for that change.

@Bosch-0Bosch-0 mentioned this pull request May 12, 2021
Merged
@Bosch-0

Bosch-0 commented May 12, 2021•
edited
Loading

Copy link
Copy Markdown
Collaborator

Really like this approach, makes things a lot cleaner. I have some suggestions however as I still think this chapter is confusing, even more so with the added bitcoin backups page. To not over complicate things I think we should merge this for now and change things in other PRs.

Meta
- Management and backup are so intertwined that each scheme's page should cover backups using that respective scheme as well as the scheme hows and whats. I don't think we need a separate page called bitcoin backups which currently overlaps heavily with the chapters content.

Change 'Automatic cloud backup' title to 'In the cloud.'
- This scheme isn't always automatic - this difference can be detailed in the page.
- Users would read 'Private key management' then 'In the cloud' and it would be clear what this section covers.
- Remove 'backup' - It's confusing having 'automatic cloud backup' then a bitcoin backups page. It just all overlaps and doesn't make sense. This page should cover the how and what's of the scheme as well as how the backup process works.

Change 'Manual backup' to 'Recovery phrase.'
- Remove backup for the same reason as the cloud page backup should be changed.
- Users would read 'Private key management' then 'Recovery phrase' and it would be clear what this section covers.
- Using the term 'Manual' doesn't really make sense as other schemes are also technically manual. Key sharing (sharding) for example involves breaking up and distributing private key pieces - is this not manual?

Change 'External signing device' to 'Signing devices.'
- Split this into three sections: Hardware wallets, phones, computers.

Change 'Key sharing' to 'Key sharding.'
- This page needs a re-work as it does not correctly communicate how this works. Sharding is the more appropriate term as keys are not being shared only pieces of a key are. These pieces also don't do any signing like the page says. I've started re-writing this here. The content in red is stuff that pertains more to backups rather than signing with keys. If we distinguish the two (with the bitcoin backups page) these details would be more relevant there. Though I think backup details should be included with the scheme as mentioned above.

Combine multi-key and shared multi-key pages and just call it Multi-Key.
- They cover similar content and would make more sense to have them together. The distinction between using it yourself or in a shared party can be made within the page.
- There isn't any details on 2-of-2 multisig wallets in this chapter when many wallets use it (Muun, greenwallet being two examples). This would be relevant in this page.

@GBKS

GBKS commented May 12, 2021

Copy link
Copy Markdown
ContributorAuthor

@Bosch-0 good feedback. How about creating a new issue so it doesn't get lost when we merge this?

@danielnordh

danielnordh commented May 12, 2021

Copy link
Copy Markdown
Contributor

@Bosch-0 good feedback. How about creating a new issue so it doesn't get lost when we merge this?

Thanks for the feedback. As it is all related to the Private Key Management pages, not this new backup page please open a new issue with this so we can address elsewhere.

@GBKS

GBKS commented May 12, 2021

Copy link
Copy Markdown
ContributorAuthor

Going to merge this now. We can then address the changes right away in new issues and PRs.

@GBKS
GBKS merged commit 6f77224 into masterMay 12, 2021
@danielnordh

danielnordh commented May 12, 2021•
edited
Loading

Copy link
Copy Markdown
Contributor

This page needs to be fixed. Links are broken and list doesn't reflect new pages.
https://bitcoin.design/guide/private-key-management/introduction/

GBKS added a commit that referenced this pull request May 12, 2021
@GBKS
Fixes links that I broke in#283
9aec108
@Bosch-0Bosch-0 mentioned this pull request May 12, 2021
Closed
GBKS added a commit that referenced this pull request May 12, 2021
@GBKS
Merge pull request#312from BitcoinDesign/feature/pkm-section-link-f…
ff31478
…ixes
Fixes links that I broke in #283
@danielnordh
danielnordh deleted the feature/pkm-section-split branch September 17, 2021 14:13
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@johnsBeharryjohnsBeharryjohnsBeharry left review comments
+2 more reviewers
@pavlenexpavlenexpavlenex approved these changes
@Bosch-0Bosch-0Bosch-0 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@GBKSGBKS

Labels

CopyTask is about improving text.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Restructure private key management pages

5 participants

@GBKS@danielnordh@Bosch-0@johnsBeharry@pavlenex