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

Replace compatibility with new matrix #1871

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
29 changes: 12 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,25 +95,20 @@ JEKYLL_ENV=local make build # Do a clean build of the site to the _site directo
diff -ruN _site _site.bak # Compare the generated sites (-r for recursive, -u for unified, -N for new file)
```

## Compatibility Matrix Data
## Bitcoin Feature Matrix Data
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@TorokNRoll do you want to include the new process for user-submitted contributions for the matrix here?


The compatibility matrix section of the website is built from
[YAML](https://yaml.org/) files located in [_compat/en](_compat/en).
The compatibility images (usability
screenshots, logos) are located in [img/compatibility/](img/compatibility/) with
sub-folders for each wallet or service. Make sure to optimize any png files using
`optipng -o7 <filename>`. These files are free for anyone to repurpose/republish
elsewhere.
The data in the Bitcoin Feature Matrix section of the website is:

We welcome pull requests to the compatibility matrix, including
testing the latest versions of previously tested services/wallets, adding notable
usability screenshots, or adding new service/wallet tests.
- collected via a Google Form
- transformed into [YAML](https://yaml.org/) files via a Google script
- located in [_data/matrix/](_data/matrix/)

When contributing changes to the compatibility matrix data files, review and adhere to
the YAML schema located in [_data/schemas/compatibility.yaml](_data/schemas/compatibility.yaml).
We welcome contributions/suggestions to the Bitcoin Feature Matrix:

If you believe any of the data in the compatibility matrix is incorrect, you
can also [submit an issue](../../issues/) detailing what is wrong and how to correct it.
- Add new products/services via the [Google Form](https://forms.gle/Vd7whDTTnyV6iNMk6)
- Request data updates via [issue submission](../../issues/)
- Propose new features to test via [issue submission](../../issues/)

If you want to request a new service or wallet be evaluated, or a new test that you
think is useful, please also submit an issue.
Changes shall be integrated during regular site updates.

Questions and requests can also be directed at [[email protected]](mailto:[email protected]).
7 changes: 1 addition & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ export GIT_PAGER='_contrib/kill0'
JEKYLL_FLAGS = --future --drafts --unpublished --incremental

## Expected filenames in output directory
compatibility_validation = $(wildcard _compat/en/*.md)
compatibility_validation := $(patsubst _compat/en/%.md,_site/en/compatibility/%/index.html,$(compatibility_validation))
topic_validation = $(wildcard _topics/en/*.md)
topic_validation := $(patsubst _topics/en/%.md,_site/en/topics/%/index.html,$(topic_validation))

Expand All @@ -38,7 +36,7 @@ build:
bundle exec jekyll build $(JEKYLL_FLAGS)


test-before-build: $(compatibility_validation) $(topic_validation)
test-before-build: $(topic_validation)
## Check for Markdown formatting problems
@ ## - MD009: trailing spaces (can lead to extraneous <br> tags
bundle exec mdl -g -r MD009 .
Expand Down Expand Up @@ -129,8 +127,5 @@ email: clean
$(MAKE) preview JEKYLL_ENV=email

## Path-based rules
_site/en/compatibility/%/index.html : _compat/en/%.md
bundle exec _contrib/schema-validator.rb _data/schemas/compatibility.yaml $<

_site/en/topics/%/index.html : _topics/en/%.md
bundle exec _contrib/schema-validator.rb _data/schemas/topics.yaml $<
96 changes: 0 additions & 96 deletions _compat/en/abra.md

This file was deleted.

82 changes: 0 additions & 82 deletions _compat/en/binance.md

This file was deleted.

117 changes: 0 additions & 117 deletions _compat/en/bitcoin-core-wallet.md

This file was deleted.

31 changes: 0 additions & 31 deletions _compat/en/bitcoin-wallet.md

This file was deleted.

Loading