LBRYCommunity/lbry.tech
1
0
Fork 0
Code Issues 13 Pull requests 8 Projects Releases Packages Wiki Activity

contribute polish and lint fixes

Browse source
This commit is contained in:
Jeremy Kauffman 2018-09-30 19:43:35 -04:00
parent 517e2ac3a2
commit a3c6276f82
8 changed files with 68 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
app/components/resources-link-grid.js
View file

@ -1,6 +1,6 @@
"use strict"; "use strict";
import linkGrid from "./link-grid" import linkGrid from "./link-grid";
export default () => { export default () => {
return linkGrid([{ return linkGrid([{
@ -19,4 +19,4 @@ export default () => {
destination: "/api/blockchain", destination: "/api/blockchain",
label: "Blockchain API" label: "Blockchain API"
}]); }]);
} };

3
app/modules/redirect.js
View file

@ -1,4 +1,3 @@
export default (url, code = 301) => { export default (url, code = 301) => {
console.log(code + ": " + url);
throw "fix this please, needs to redirect to:" + url; throw "fix this please, needs to redirect to:" + url;
} };

12
app/sass/init/_markdown.scss
View file

@ -119,6 +119,12 @@
top: -1px; top: -1px;
} }
} }
+ h2 {
margin-top: 2rem;
}
+ h3, + h4, + h5 {
margin-top: 1.5rem;
}
} }
p, p,
@ -147,10 +153,6 @@
margin-bottom: 0.25rem; margin-bottom: 0.25rem;
} }
} }
+ h2, + h3, + h4, + h5 {
padding-top: 2rem;
}
} }
ol { ol {
@ -170,6 +172,8 @@
} }
p { p {
margin-left: 2px;
margin-right: 2px;
img { img {
float: right; float: right;
} }

9
app/views/api.js
View file

@ -28,8 +28,7 @@ module.exports = exports = state => parseApiFile(state.params.wildcard).then(res
<section class="api__content" id="toc-content">${createApiContent(response)}</section> <section class="api__content" id="toc-content">${createApiContent(response)}</section>
</div> </div>
<script src="/assets/scripts/plugins/jets.js"></script>
<script src="/assets/scripts/api.js"></script>
`); `);
*/ */
@ -52,14 +51,14 @@ module.exports = exports = state => parseApiFile(state.params.wildcard).then(res
<ul class="api__toc__search__results"></ul> <ul class="api__toc__search__results"></ul>
</div> </div>
<ul class="api__toc__items" id="toc" role="navigation">${raw(createApiSidebar(response).join(""))}</ul> <ul class="api__toc__items" id="toc" role="navigation">${createApiSidebar(response)}</ul>
</aside> </aside>
<section class="api__content" id="toc-content">${raw(createApiContent(response).join(""))}</section> <section class="api__content" id="toc-content">${createApiContent(response)}</section>
</div> </div>
<script src="/assets/scripts/plugins/jets.js"></script> <script src="/assets/scripts/plugins/jets.js"></script>
${raw(apiScripts)} <script src="/assets/scripts/api.js"></script>
`; `;
}); });

26
app/views/home.js
View file

@ -16,19 +16,19 @@ module.exports = exports = () => html`
<section class="features"> <section class="features">
${linkGrid([ ${linkGrid([
{ {
description: "Learn how LBRY works with 3 easy examples", description: "Learn how LBRY works with 3 easy examples",
destination: "/tour", destination: "/tour",
label: "Take the Tour", label: "Take the Tour",
title: "New to LBRY?" title: "New to LBRY?"
}, },
{ {
description: "Help make LBRY better!", description: "Help make LBRY better!",
destination: "/contribute", destination: "/contribute",
label: "Explore our repos", label: "Explore our repos",
title: "Want to contribute?" title: "Want to contribute?"
} }
])} ])}
</section> </section>
<section class="intro"> <section class="intro">

14
app/views/redirect.js
View file

@ -11,7 +11,7 @@ import fs from "graceful-fs";
import html from "choo/html"; import html from "choo/html";
import path from "path"; import path from "path";
import { require as local } from "app-root-path"; import { require as local } from "app-root-path";
import redirects from '../data/redirects.json'; import redirects from "../data/redirects.json";
import redirect from "../modules/redirect"; import redirect from "../modules/redirect";
import Page404 from "./404.js"; import Page404 from "./404.js";
import raw from "choo/html/raw"; import raw from "choo/html/raw";
@ -130,12 +130,12 @@ function partialFinder(markdownBody) {
function wikiFinder(markdownBody) { function wikiFinder(markdownBody) {
return markdownBody.replace(/\[\[([\w\s/-]+)\]\]/g, (match, p1) => { return markdownBody.replace(/\[\[([\w\s/-]+)\]\]/g, (match, p1) => {
const label = p1.trim(), const label = p1.trim(),
href = encodeURI("/glossary#" + label.replace(/\s+/g, '-')); href = encodeURI("/glossary#" + label.replace(/\s+/g, "-"));
return label ? return label ?
`<a href="${href}" class="link--glossary">${label}</a>` : `<a href="${href}" class="link--glossary">${label}</a>` :
match.input; match.input;
} }
); );
} }

50
documents/contribute.md
View file

@ -29,15 +29,15 @@ If you want to contribute to LBRY, there's definitely something for you! The fir
### Official Applications ### Official Applications
| Application | Language (Toolset) | What Is It | Application | Language (Toolset) | What Is It
--- | --- | --- --- | --- | ---
| [lbry-desktop](https://github.com/lbryio/lbry-desktop) | JavaScript (ReactJS, Electron) | A graphical browser for the LBRY protocol for Windows, macOS, and Linux. [[lbry-desktop]] uses the [[lbry-sdk]] | [lbry-desktop](https://github.com/lbryio/lbry-desktop) | JavaScript (ReactJS, Electron) | A graphical browser for the LBRY network for Windows, macOS, and Linux. [[lbry-desktop]] is built with [[lbry-sdk]]. |
| [lbry-android](https://github.com/lbryio/lbry-desktop) | JavaScript (ReactNative), Python (kivy) | A graphical browser for the LBRY protocol for Android. `lbry-android` bundles `lbry` and is primarily frontend code. | [lbry-android](https://github.com/lbryio/lbry-desktop) | JavaScript (ReactNative), Python (kivy) | A graphical browser for the LBRY network for Android. [[lbry-android]] is built with [[lbry-sdk]].
| [lbry-redux](https://github.com/lbryio/lbry-redux) | JavaScript (Redux) | A common codebase for shared Redux logic between `lbry-desktop` and `lbry-android`. | [lbry-redux](https://github.com/lbryio/lbry-redux) | JavaScript (Redux) | A common codebase for shared Redux logic between [[lbry-desktop]] and [[lbry-android]].
| [spee.ch](https://github.com/lbryio/spee.ch) | JavaScript (Node, ReactJS, Express) | A web-based host for free LBRY content. Usable directly as a content link dump site or as a customized, standalone install. | [spee.ch](https://github.com/lbryio/spee.ch) | JavaScript (Node, ReactJS, Express) | A web-based host for free LBRY content. Usable directly as a content link dump site or as a customized, standalone install.
### Websites ### Websites
| Domain | Language (Toolset) | What Is It | Domain | Language (Toolset) | What Is It
--- | --- | --- --- | --- | ---
| [lbry.tech](https://github.com/lbryio/lbry.tech) | JavaScript (Vue, Vuepress) | You're on it. | [lbry.tech](https://github.com/lbryio/lbry.tech) | JavaScript (Node, Choo) | You're on it.
| [lbry.io](https://github.com/lbryio/lbry.io) | PHP (vanilla) | A website for LBRY end-users and creators. | [lbry.io](https://github.com/lbryio/lbry.io) | PHP (vanilla) | A website for LBRY end-users and creators.
| [lbry.fund](https://github.com/lbryio/lbry.fund) | HTML | A website for receiving funding from LBRY, Inc. | [lbry.fund](https://github.com/lbryio/lbry.fund) | HTML | A website for receiving funding from LBRY, Inc.
@ -48,20 +48,18 @@ If you want to contribute to LBRY, there's definitely something for you! The fir
| [lighthouse](https://github.com/lbryio/lighthouse) | JavaScript, ElasticSearch | A search service for the LBRY blockchain. | [lighthouse](https://github.com/lbryio/lighthouse) | JavaScript, ElasticSearch | A search service for the LBRY blockchain.
| [wunderbot](https://github.com/lbryio/lbry-wunderbot) | JavaScript (Node) | A chatbot used by the LBRY discord. | [wunderbot](https://github.com/lbryio/lbry-wunderbot) | JavaScript (Node) | A chatbot used by the LBRY discord.
| [block-explorer](https://github.com/lbryio/block-explorer) | PHP (vanilla) | A blockchain explorer for the LBRY blockchain. | [block-explorer](https://github.com/lbryio/block-explorer) | PHP (vanilla) | A blockchain explorer for the LBRY blockchain.
| Add more? other tipbots... |
## Coding ## Coding
Several hundred extremely good-looking, intelligent and popular people, as well as our CTO, have contributed to LBRY. Join us! Several hundred extremely good-looking, intelligent and popular people, as well as our CTO, have contributed to LBRY. Join us!
Additionally, every technical employee of LBRY outside of the founding team started as a public contributor.
### How To Contribute Code ### How To Contribute Code
1. **Identify the component you want to work on**. LBRY has code bases in Python, JavaScript, PHP, and C++. See [Ecosystem Overview](#ecosystem-overview). 1. **Join the Community**. By joining our [chat](https://chat.lbry.io) or our [forum](https://discourse.lbry.io), you can interact with other developers when you have questions, ideas, or problems.
1. **Get set up.** Each repo has a `README.md` with clear instructions on how to get the repo up and running properly. Thanks, [Repository Standards](/repository-standards)! 1. **Identify the component you want to work on**. LBRY has code bases that deal with everything from cryptography and distributed systems to end-user graphic user-interfaces. We use Python, JavaScript, C++, Go, and more. See [Ecosystem Overview](#ecosystem-overview) to find the right project.
1. **Find something to work on**. All actively developed repositories should have issues tagged "Good First Issues" specifically for new contributors. Some projects use a "level: n" tagging system, where lower numbers are simpler and higher numbers are more complex. Of course, you are also welcome to work on something not currently filed if you have your own idea! Additionally, all repositories have contact information for the maintainer if you have trouble finding an issue to work on. 1. **Get set up.** Each repo has a [[README]] with clear instructions on how to get the repo up and running properly. Thanks, [Repository Standards](/repository-standards)!
1. **Abide coding and commit standards**. Any specific information necessary to know in this regard should be in the `README`. 1. **Find something to work on**. All actively developed repositories should have issues tagged "Good First Issues" specifically for new contributors. You are also welcome to work on something not currently filed if you have your own idea. Additionally, all repositories have contact information for the maintainer if you have trouble finding an issue to work on.
1. **Abide coding and commit standards**. Any specific information necessary to know in this regard should be in the project [[README]].
1. **Commit early and ask questions**. Is an issue confusing? Please comment and say so! Not sure if you've got the right approach? Commit your code and we'll give feedback. Certain you're doing everything right? Commit it anyway. Once you commit, open a pull request. We encourage work-in-progress commits to let us know you're working on something and to facilitate feedback. 1. **Commit early and ask questions**. Is an issue confusing? Please comment and say so! Not sure if you've got the right approach? Commit your code and we'll give feedback. Certain you're doing everything right? Commit it anyway. Once you commit, open a pull request. We encourage work-in-progress commits to let us know you're working on something and to facilitate feedback.
1. **Accept feedback and finish**. Most pull requests are reviewed within two business days. Once the repository maintainer has approved your contribution, it will get merged and we'll try really hard to give you LBC even if you say no. 1. **Accept feedback and finish**. Most pull requests are reviewed within two business days. Once the repository maintainer has approved your contribution, it will get merged and we'll try really hard to give you LBC even if you say no.
@ -69,12 +67,14 @@ Additionally, every technical employee of LBRY outside of the founding team star
Web and application designers are requested to be able to work directly on CSS in the project they'd be contributing to. Please follow the [Coding](#coding) instructions for any website or application you want to improve. Web and application designers are requested to be able to work directly on CSS in the project they'd be contributing to. Please follow the [Coding](#coding) instructions for any website or application you want to improve.
We're happy to provide assistance if you're used to working in HTMl and CSS but are having trouble getting started. Check out [our chat](https://chat.lbry.io) or [our forum](https://discourse.lbry.io).
## Writing ## Writing
Most written content at LBRY is checked into source control. To improve content we've written: Most written content, and especially all technical writing, is checked into source control. To improve content we've written or add new content:
1. Identify which website or application it is in (see the [overview])(#ecosystem-overview). 1. Identify which website or application it is in (see the [overview])(#ecosystem-overview).
1. Search for a quoted phrase of the content you want to change. 1. Search for a quoted phrase of the content you want to change (or use the same technique to identify the folder to create a new document in).
1. Edit the content via the GitHub interface and submit it as a pull request. 1. Edit the content via the GitHub interface and submit it as a pull request.
## Testing ## Testing
@ -83,19 +83,21 @@ If you want to contribute without getting directly into the code, one of the bes
A number of our code bases ([[lbrycrd]], [[lbry-sdk]], all applications, more...) go through regular release cycles where new versions are shipped every several weeks. Testing pre-release versions is a great way to help us identify issues and ship bug-free code. A number of our code bases ([[lbrycrd]], [[lbry-sdk]], all applications, more...) go through regular release cycles where new versions are shipped every several weeks. Testing pre-release versions is a great way to help us identify issues and ship bug-free code.
For any projects that you want to be a tester on, "Watch" the repo on GitHub. You will receive an email with release notes whenever a release candidate is out. ### Ways to Test
For even harder-core testing, you can follow the `README` instructions in a project and test against the `master` branch of a project at any time. Additionally, `master` builds for some projects are always available via [build.lbry.io](http://build.lbry.io). - "Watch" the repo on GitHub. You will receive an email with release notes whenever a release candidate is out and you can [raise an issue](#raising-issues).
- Join the #early-testing channel in our [chat](https://chat.lbry.io).
- For the hardcore, run master from source and/or the latest builds from [build.lbry.io](http://build.lbry.io).
Opening well-specified issues against release candidates or master builds is extremely useful in helping us create quality software. Opening well-specified issues against release candidates or master builds is extremely useful in helping us create quality software.
**Note: that you perform testing at your own risk! If using release candidates and especially master builds, back up your wallet and be cautious.** **Note: Please do not use wallets with substantial sums when testing. If using release candidates and especially master builds, back up your wallet and be cautious. While a substantial bug, like one that caused loss of funds, would merit significant [Appreciation](#appreciation), you perform testing at your own risk.**
## Raising Issues ## Raising Issues
If you're about to raise an issue because you've found a problem with LBRY, or you'd like to request a new feature, or for any other reason, please read this first. All [bug reports](#reporting-a-bug) and [feature requests](#feature-requests) are managed through GitHub.
GitHub is the preferred channel for [bug reports](#reporting-a-bug) and [feature requests](#feature-requests). If you're about to raise an issue because you've found a problem with LBRY, or you'd like to request a new feature, or for any other reason, please read this first.
### Reporting a Bug ### Reporting a Bug
@ -103,10 +105,10 @@ A bug is a _demonstrable problem_ that is caused by the code in the repository.
Guidelines for bug reports: Guidelines for bug reports:
1. **Identify the correct repo**. See [ecosystem overview](#ecosystem-overview). While it's okay if you get this wrong, it's a big help to us if you get it right. 1. **Identify the correct repo**. See [ecosystem overview](#ecosystem-overview). While it's okay if you get this wrong, it's a big help to us if you get it right.
2. **Use the GitHub issue search** — check if the issue has already been reported (or fixed). Be sure to include closed tickets in your search. 2. **Check if the issue exists**. Please do a quick search to see if the issue has been reported (or fixed), including closed tickets.
3. **Follow the instructions** — When you open an issue inside of GitHub, each repo contains a template for how to create a good bug report. Please follow it! 3. **Follow the instructions** - When you open an issue inside of GitHub, each repo contains a template for how to create a good bug report. Santa _loves_ people who follow it.
Well-specified bug reports save developers lots of time and are extremely appreciated, typically with an LBRY credit tip. Well-specified bug reports save developers lots of time and are [appreciated](#appreciation).
### Feature Requests ### Feature Requests
@ -117,6 +119,12 @@ Feature requests are welcome. Before you submit one be sure to:
3. **Consider whether it's feasible** for us to tackle this feature in the next 6-12 months. The LBRY team is currently stretched thin just adding basic functionality. If this is a nice to have rather than a need, it is probably more clutter than helpful. 3. **Consider whether it's feasible** for us to tackle this feature in the next 6-12 months. The LBRY team is currently stretched thin just adding basic functionality. If this is a nice to have rather than a need, it is probably more clutter than helpful.
4. **Make a strong case** to convince the project's leaders of the merits of this feature. Please provide as much detail and context as possible. This means explaining the use case and why it is likely to be common. 4. **Make a strong case** to convince the project's leaders of the merits of this feature. Please provide as much detail and context as possible. This means explaining the use case and why it is likely to be common.
### Discussion and Help
Sometimes, you may have a problem but an issue isn't appropriate (or you're not sure if it's a real issue).
Join our [chat](https://chat.lbry.io), our [forum](https://discourse.lbry.io), or another [community](https://lbry.tech/community) and talk to others about it.
## Appreciation ## Appreciation
We offer LBC as a gesture of our appreciation to anyone who contributes to LBRY. While we're generous in what we send, it is more about recognizing and appreciating what you've given to the community than providing compensation. We offer LBC as a gesture of our appreciation to anyone who contributes to LBRY. While we're generous in what we send, it is more about recognizing and appreciating what you've given to the community than providing compensation.

4
documents/glossary.md
View file

@ -258,6 +258,10 @@ Note that owning a very large amount of computational power does not override ot
A 2D point on an elliptic curve [secp256k1](https://en.bitcoin.it/wiki/Secp256k1) that is produced by multiplying a predefined "generator" point by a *private key*. Usually it is represented by a pair of 256-bit numbers ("uncompressed public key"), but can also be compressed to just one 256-bit number (at the slight expense of CPU time to decode an uncompressed number). A special hash of a public key is called *address*. Typical LBRY transactions contain public keys or addresses in the output scripts and *signatures* in the input scripts. A 2D point on an elliptic curve [secp256k1](https://en.bitcoin.it/wiki/Secp256k1) that is produced by multiplying a predefined "generator" point by a *private key*. Usually it is represented by a pair of 256-bit numbers ("uncompressed public key"), but can also be compressed to just one 256-bit number (at the slight expense of CPU time to decode an uncompressed number). A special hash of a public key is called *address*. Typical LBRY transactions contain public keys or addresses in the output scripts and *signatures* in the input scripts.
### README
A README is a file included in all code repositories that includes basic information about that project. More in (/resources/repository-standards).
### Reflector ### Reflector
A reflector cluster to accept LBRY content for hosting en masse, re-host the content, and make money on data fees (currently disabled). This code includes Go implementations of the LBRY peer protocol, reflector protocol, and DHT. A reflector cluster to accept LBRY content for hosting en masse, re-host the content, and make money on data fees (currently disabled). This code includes Go implementations of the LBRY peer protocol, reflector protocol, and DHT.