Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blog: add post with all bech32 content to date #146

Merged
merged 2 commits into from May 23, 2019

Conversation

@harding
Copy link
Contributor

@harding harding commented May 22, 2019

Closes #128

This moves each bech32 sending support section into a separate includable file and then includes each of them in two different places: first, in the newsletter that originally included them; second, in a blog post backdated to the start of our series. I think this makes the combined content highly accessible, as it's all easily searchable using find-in-page.

This required moving links around and also moving where we included references.md in some previous newsletters (because it contains variable definitions, it must appear before we use those variables, which means including it before the subsequently-included bech32 sections. However, it can't go at the very top of the file, since that breaks the automatic first-paragraph summary used on the newsletter index page.)

A separate commit in this PR also adds a script that automates most of the work of creating the link reference definitions for old newsletters. Manually creating those links was annoying for me, even if it only took 30 seconds a week.

When making a change like this that makes a lot of backend changes but minimal frontend changes, my preferred testing method is comparing diffs of the rendered site. E.g.:

git checkout 4c551cc0    ## before these changes
make
cp -a _site _old_site
git checkout <this PR>
make
diff -ruN _old_site _site | colordiff | less -R

I think that looks good. (You can drop the -N from diff to suppress new files so that you only see the changes to existing files, which is a minimal diff.)

@moneyball
Copy link
Contributor

@moneyball moneyball commented May 22, 2019

tACK. Note that I only built locally and tested - I didn't review the actual changes, so someone else should do that.

I'm glad we're doing this now so that we have something easily shareable. It is already an impressive compilation.

I assume we plan to append each week's section to this when we publish the weekly newsletter?

Also this seems to belong in our scaling book too ... maybe repurpose it there in August when all 24 are complete?

@harding
Copy link
Contributor Author

@harding harding commented May 22, 2019

I assume we plan to append each week's section to this when we publish the weekly newsletter?

Yep. Sections from this point forward will be written in the _includes dir and then added to both that week's newsletter and this blog post.

Copy link
Contributor

@jnewbery jnewbery left a comment

Tested ACK 661e000.

Looks great. Thanks Dave!


excerpt: >
Copies of all published parts from our weekly series on bech32 sending
support, scheduled to run 24 weeks from March 19th to August 28th,
Copy link
Contributor

@jnewbery jnewbery May 22, 2019

Choose a reason for hiding this comment

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

If you s/scheduled to run/running for/ we won't need to update this once the series is complete.

{% include references.md %}

On this page are copies of all published parts from our weekly series
on bech32 sending support, scheduled to run 24 weeks from March 19th to
Copy link
Contributor

@jnewbery jnewbery May 22, 2019

Choose a reason for hiding this comment

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

As above, consider s/scheduled to run/running for/.


*Originally publised in [Newsletter #47][].*

{% include specials/bech32/10-snooze-lose.md %}
Copy link
Contributor

@jnewbery jnewbery May 22, 2019

Choose a reason for hiding this comment

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

snooze-lose 👍

@harding harding force-pushed the 2019-05-bech32-index branch from 661e000 to 983a2fb May 22, 2019
@harding
Copy link
Contributor Author

@harding harding commented May 22, 2019

@jnewbery the sentence has been rephrased. Thanks!

@jnewbery
Copy link
Contributor

@jnewbery jnewbery commented May 23, 2019

ACK 983a2fb. Thanks Dave!

@jnewbery jnewbery merged commit ff1f61f into bitcoinops:master May 23, 2019
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

3 participants