bitcoin-core-review-club / website Goto Github PK
View Code? Open in Web Editor NEWBitcoin Core PR Review club website
Home Page: https://bitcoincore.reviews/
Bitcoin Core PR Review club website
Home Page: https://bitcoincore.reviews/
Instead of having people rely on Twitter or announcements in the IRC channel, I think having an RSS feed would be nice?
The most naive approach is to push an update for any change to the _posts/
dir, or perhaps more elegantly could also allow people to individually subscribe to announcements, questions/nodes, and logs updates.
Found e.g. https://github.com/jekyll/jekyll-feed which seems to also supports tagging.
It's perhaps worth keeping a glossary so we don't have to continuously re-define things like ancestor feerate, block-relay-only connections, effective fees in coin selection, etc. We sometimes link to previous review clubs, but that also doesn't offer a direct definition. Maybe something similar to bitcoinops topics (so it's easily linkable and back-linkable) but for low-level terms.
@miketwenty1 mentioned that it's not immediately obvious what the purpose of the IRC is when arriving at the landing page: https://bitcoincore.reviews/. There is some rationale ("The point of the review club is to give participants..." but it's a bit vague and buried in the middle of the text).
Mike - perhaps you could suggest some alternative text?
The Gemfile needs to be present for bundle install
to function. The usual practice would be to commit it in the repository.
Help
Originally posted by @Ronnie6464 in #688 (comment)
We currently do meetings weekly. Here are a few observations and disadvantages:
Ideally:
Proposal:
The URL is right next to the project description on GitHub
We now use netlify to host this site instead of github pages. If the repo is named <org>/<org>.github.io
, then github will automatically try to build it as a github page. That no longer works for this site since we're using a custom plugin, so I get these notifications:
[bitcoin-core-review-club/bitcoin-core-review-club.github.io] Page build failure
The page build failed for the
master
branch with the following error:The tag
irc
on line 3 in_posts/2019-05-01-#15557.md
is not a recognized Liquid tag. For more information, see https://help.github.com/en/github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites#unknown-tag-error.For information on troubleshooting Jekyll see:
https://help.github.com/articles/troubleshooting-jekyll-builds
If you have any questions you can submit a request on the Contact GitHub page at https://support.github.com/contact/pages?repo_id=185674396&page_build_id=170390927
I think the easiest way to spare myself these emails is to rename the repo to something like website
.
I'll do that in the next couple of days unless anyone complains.
As a follow-up to #28:
Name them "Meetings" or "PR Reviews" instead of "Previous Meetings", and list all of the meetings, not just previous ones.
On the Meetings by date listing, consider breaking up the growing list a bit by adding some space (css padding) between months.
I've summarized a previous Review Club meeting for the Optech newsletter (here: bitcoinops/bitcoinops.github.io#366 (comment)). For those summaries, it'd be really useful to be able to link specific lines in the meeting log. For that we'd need id or name attributes for each line.
@ajttowns bot does that automatically, eg http://www.erisian.com.au/bitcoin-core-dev/log-2020-03-10.html#l-3. Perhaps it's time to start doing something a bit smarter than copy-pasting meeting logs so we can add more structure to the logs.
The monthly Review Club section of the Optech newsletter wants to link to specific lines of the Meeting Log. This works fine for Meeting 1, but the log line numbers for Meeting 2 start again at 1, and those line numbers (which are links) bring you back to the corresponding line number in Meeting 1. So there doesn't seem to be a way to link to lines in the Meeting 2 log.
To see the problem, click on one of the Meeting 2 line numbers here: https://bitcoincore.reviews/28122
An obvious solution would be to not restart the line numbers at Meeting 2, just let them continue where they left off at the end of Meeting 1.
I don't know if there's a way to fix this particular document (28122) quickly, but the Optech write-up is due in the next day or two (sorry about reporting this so last-minute).
I'll ask Dave Harding if we could push the Review Club section until next week; we've done that before, so it shouldn't be a problem. That will allow an extra week to fix this. I'll report back here when I get a reply from Dave.
Please comment in this issue to request PRs to be covered in future review club meetings.
Does someone still have the log for https://bitcoin-core-review-club.github.io/15759.html? I sometimes go back to old sessions to lookup stuff, and this PR was really interesting.
After #21, each PR page will have a component and host tag. Add per-component and per-host index pages so interested users can look for all PRs by a component. I expect the URL scheme will be eg https://bitcoin-core-review-club.github.io/component/wallet
, https://bitcoin-core-review-club.github.io/host/jonatack
, etc
This site is one of the best resources on the internet to learn about the Bitcoin Core. Why not having its content as a pdf file format? Having it as a pdf, makes its content more portable and easier to read. Personally sometime I wanted to read site's notes offline but it wasn't possible.
We can develop a python script to read data from _posts
directory and generate a pdf file as output. So every week someone can pull recent commits from repository and run the script, and enjoy having the latest version of the pdf, containing all notes and discussions of bitcoin-core-review-club.
Furthermore, we can add the script in github workflows, and set it to be run by every merge to master and uploading the file. Thus we have always the latest version of pdf available in the repo.
For the review clubbies who consume meetings like youtube videos, I wish we had a section at the end of meetings for "related PR review clubs."
I think it's nice to link to other review clubs we've done on the same topic (e.g. Minisketch/Erlay, coin selection, deployments). But it's unmaintainable if it requires the host/someone to remember all past review clubs. I think the best approach would be to (optionally) tag meetings with a topic from a list of topics in the preamble (more specific than the component groupings, perhaps can correspond to optech topics). That way we can tear down with a quick sed script if we change our mind.
We render all meeting participants in the same color. A couple of people have suggested to me that each participant should have a separate color to make it easier to follow threads. Not sure how much effort it'd be to implement it or how useful in general, but I'm opening this issue to track that request.
currently:
proposed:
Often, the PR branch will change after we've run review club. That's bad for our archives because:
One solution is to make a fork of bitcoin at bitcoin-core-review-club/bitcoin
and then tag the PR branch before the review club, and use that tagged branch for all links. As a tagged branch in that repo, it'll persist and the links will stay live.
I'm currently using Ruby 2.6.6p146 (2020-03-31) with this repo (and so an updated Gemfile.lock
as well), so this may or may not affect anyone using a different major version like Ruby 2.5.x, but here's a quick public service announcement, if helpful:
To run make preview
, I needed to add the following line to the Gemfile and run bundle update
:
diff --git a/Gemfile b/Gemfile
index 71b0ef9..52bd101 100644
--- a/Gemfile
+++ b/Gemfile
@@ -8,6 +8,7 @@ gem "jekyll-paginate", "~> 1.1"
gem "jekyll-sitemap", "~> 1.3"
gem "jekyll-feed", "~> 0.12.1"
gem "jekyll-seo-tag", "~> 2.6"
+gem "kramdown-parser-gfm"
From @jonatack (#21 (comment))
A couple of future ideas:
hi @glozow
would you accept a PR that enables dark mode for users whose operating system indicates prefers-color-scheme:dark ?
i'd be happy to take a look at that
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.