Browse Source

Updating all the other faqs to pull from the central repo

Signed-off-by: Mary Anthony <mary@blockstack.com>
feat/clarity-updates
Mary Anthony 6 years ago
parent
commit
6ab8ddeeba
  1. 74
      _browser/faq_general.md
  2. 149
      _core/faq_developer.md
  3. 8
      _core/faq_technical.md
  4. 12
      _data/navigation_org.yml
  5. 22
      _org/overview.md

74
_browser/faq_general.md

@ -5,74 +5,14 @@ permalink: /:collection/:path.html
# Users Frequently Asked Questions (FAQ) # Users Frequently Asked Questions (FAQ)
{:.no_toc} {:.no_toc}
This is a general FAQ intended for users of decentralized applications. If you are a developer, refer to the [technical FAQ]. This is a FAQ intended for users of decentralized applications. A comprehensive list of FAQs that touch on general, technical, and App Mining questions is [also available]({{site.baseurl}}/faqs/allFAQS.html).
* TOC * TOC
{:toc} {:toc}
{% for faq in site.data.theFAQs.faqs %}
## What is the decentralized internet? {% if faq.category == 'appusers' %}
### {{ faq.question }}
The Blockstack ecosystem enables the new decentralized internet. Decentralization means authority moving from central authority to local authority. Simply put, in a decentralized internet, you own your data, not the applications or services you use. {{ faq.answer }}
{% endif %}
Blockstack envisions a world where users control their own data, and power flows back to the users. For example, when you buy something from an online company, that company collects and stores data about you: {% endfor %}
* your name
* the information about the product you bought
* the number on your credit card
In the decentralied internet, that information stays with you and it isn't
collected or stored by anyone. Applications that operate in the decentralized
internet are called _decentralized applications_ or DApps for short.
## What is Blockstack?
Blockstack is an ecosystem to support both DApp users and DApp developers. For
users, Blockstack makes software to create Blockstack identities and find DApps.
For developers, Blockstack develops an ecosystem of software and services that developrs can use to build DApps.
## How do DApps differ applications I typically use?
DApps differ from Web applications in two ways:
* **Users have identities not accounts**. The user brings their identity to the
applications; applications do not require the user to create accounts and
passwords.
* **Users own their data**. Users control access to their data. Users decide where to store their data and which applications can read or write to your. Companies and their decentralized applications don't keep or save your data.
## Where is my identity kept?
Your identity is a unique string you and other people can read such as `moxiegirl.id`. A private key is a string of letters only you know. When you create an identity, a **hash** is made of your id and your private key registered with Blockstack.
Your personal data storage is built around this ID. Apps that want to access your data use your permission and identity to find it.
You have to remember and keep your private key in a safe place like a password manager. If you lose a private key, _no one else, no person, no software, can help you get your identity back_.
## Can Blockstack control my data or ID when I use it?
No. When you're using a Blockstack client you control your data and ID with a
private key. As long as no one gets access to your private key, no one can
control your data or ID. When you use Blockstack, by design, your private keys
are never sent to any remote servers.
## Do DApps work with a regular browser?
Yes! DApps run in the web browsers (Chrome, Safari, Internet Explorer, etc.) you know and love.
## What is the Blockstack Browser?
The Blockstack Browser is the DApp users use to create and manage their identities and configure their data storage. The browser is also where users can go to discover and use apps using Blockstack.
The Blockstack Browser also handles login requests from DApps that allow their users to log in with Blockstack. When a user clicks a **Log In with Blockstack** button, they are redirected to the Blockstack Browser to approve the request before being logged into the app.
## Are Blockstack applications usable today?
Yes! Blockstack applications are as easy to use as normal Web applications, if
not easier. Moreover, they are just as performant if not more so.
If you install the [Blockstack
Browser](https://github.com/blockstack/blockstack-browser), or use our
[Web-hosted Blockstack Browser](https://browser.blockstack.org), you can get
started with them right away.

149
_core/faq_developer.md

@ -2,141 +2,36 @@
layout: learn layout: learn
permalink: /:collection/:path.html permalink: /:collection/:path.html
--- ---
# Developer FAQs # DApp Developer FAQs
{:.no_toc} {:.no_toc}
These FAQs are intended for developers of Blockstack. This document lists frequently-asked questions developers about Blockstack application development. If you are new to Blockstack, you should read the [general questions]({{site.baseurl}}/faqs/allFAQs.html) first.
* TOC For more technical questions about Blockstack Core nodes, the Stacks blockchain, and other architectural elements, see the [core developer questions]({{site.baseurl}}/core/faq_technical.html).
{:toc}
## I'm a web developer. Can I build on Blockstack?
Yes! Blockstack is geared primarily towards web developers. All of your
existing knowledge is immediately applicable to Blockstack. Anything you can do
in a web browser, you can do in a Blockstack app.
## I'm a non-web developer. Can I build on Blockstack?
Yes! Blockstack implements a [RESTful API](https://core.blockstack.org) which
lets you interact with Blockstack from any language and any runtime. In fact,
the reference client
([blockstack.js](https://github.com/blockstack/blockstack.js)) is mainly a
wrapper around these RESTful API calls, so you won't be missing much by using a
language other than Javascript.
## What's the difference between a web app and a Blockstack app?
Blockstack apps are built like [single-page web
apps](https://en.wikipedia.org/wiki/Single-page_application)--- they are, in
fact, a type of web application.
Blockstack apps are a subset of web applications that use Blockstack's
technology to preserve the user's control over their identities and data. As
such, they tend to be simple in design and operation, since in many cases they
don't have to host anything besides the application's assets.
## Do I need to learn any new languages or frameworks?
No. Blockstack applications are built using existing web frameworks and programming
The only new thing you need to learn is either [blockstack.js](https://github.com/blockstack/blockstack.js) or
the [Blockstack RESTful API](https://core.blockstack.org).
## How does my web app interact with Blockstack?
The [blockstack.js](https://github.com/blockstack/blockstack.js) library gives
any web application the ability to interact with Blockstack's authentication and
storage services. In addition, we supply a [public RESTful API](https://core.blockstack.org).
## What does `blockstack.js` do?
This is the reference client implementation for Blockstack. You use it in your
web app to do the following:
* Authenticate users
* Load and store user data
* Read other users' public data
## How do I use `blockstack.js`?
We have [several examples](/browser/hello-blockstack.html) you can use to get started. Please see the API documentation [here](https://github.com/blockstack/blockstack.js). If you have a technical question that gets frequently asked on the
[forum](https://forum.blockstack.org) or [Slack](https://blockstack.slack.com),
feel free to send a pull-request with the question and answer.
## How can I look up names and profiles? * TOC
{:toc}
You can use `blockstack.js`, or you can use the [public Blockstack Core
endpoint](https://core.blockstack.org).
## How can I read my public app data without `blockstack.js`?
The URLs to a user's public app data are in a canonical location in their
profile. For example, here's how you would get public data from the
[Publik](https://publik.ykliao.com) app, stored under the Blockstack ID `ryan.id`.
1. Get the bucket URL
```bash
$ BUCKET_URL="$(curl -sL https://core.blockstack.org/v1/users/ryan.id | jq -r '."ryan.id"["profile"]["apps"]["http://publik.ykliao.com"]')"
$ echo "$BUCKET_URL"
https://gaia.blockstack.org/hub/1FrZTGQ8DM9TMPfGXtXMUvt2NNebLiSzad/
```
2. Get the data
```bash
$ curl -sL "${BUCKET_URL%%/}/statuses.json"
[{"id":0,"text":"Hello, Blockstack!","created_at":1515786983492}]
```
## How do I register Blockstack IDs?
You should use the [Blockstack Browser](https://github.com/blockstack/blockstack-browser).
## How do I register Blockstack Subdomains?
You can deploy and use a [Blockstack Subdomain Registrar]({{ site.baseurl }}/core/naming/subdomains.html), or
use an existing one.
## Can I programmatically register Blockstack IDs?
Blockstack applications do not currently have
have access to the user's wallet. Users are expected to
register Blockstack IDs themselves.
However, if you feel particularly ambitious, you can do one of the following:
* Set up a `blockstack api` endpoint (see the project [README](https://github.com/blockstack/blockstack-core/blob/master/README.md)) and write a
program to automatically register names. Also, see the [API
documentation](https://core.blockstack.org//#managing-names-register-a-name)
for registering names on this endpoint.
* Write a `node.js` program that uses `blockstack.js` to register
names. This is currently in development.
## Can I programmatically register Blockstack Subdomains?
Yes! Once you deploy your own subdomain registrar, you can have your web app
send it requests to register subdomains on your Blockstack ID. You can also
create a program that drives subdomain registration on your Blockstack ID.
## Do you have a testnet or sandbox to experiment with Blockstack?
We have an [integration test framework](https://github.com/blockstack/blockstack-core/tree/master/integration_tests) that provides a ## DApp developers
private Blockstack testnet. It uses `bitcoin -regtest` to create a private
blockchain that you can interact with, without having to spend any Bitcoin or
having to wait for blocks to confirm. Please see the
[README](https://github.com/blockstack/blockstack-core/blob/master/integration_tests/README.md) for details.
## Does Blockstack have a smart contract system? {% for faq in site.data.theFAQs.faqs %}
{% if faq.category == 'dappdevs' %}
### {{ faq.question }}
{{ faq.answer }}
{% endif %}
{% endfor %}
No, not yet. This is because
Blockstack's design philosophy focuses on keeping system complexity at the
"edges" of the network (e.g. clients), instead of the "core" of the network (e.g.
the blockchain), in accordance with the [end-to-end
principle](https://en.wikipedia.org/wiki/End-to-end_principle).
Generally speaking, this can be interpreted as "if you can do X without
a smart contract, you should do X without a smart contract." This organizing
principle applies to a lot of useful decentralized applications.
## Can Blockstack applications interact with Bitcoin? Ethereum? Smart contracts? Other blockchains? ## Open source developers
Yes! Since Blockstack applications are built like web applications, all you need to do is include the {% for faq in site.data.theFAQs.faqs %}
relevant Javascript library into your application. {% if faq.category == 'opensource' %}
### {{ faq.question }}
{{ faq.answer }}
{% endif %}
{% endfor %}

8
_core/faq_technical.md

@ -2,12 +2,12 @@
layout: core layout: core
permalink: /:collection/:path.html permalink: /:collection/:path.html
--- ---
# Blockstack Technical FAQ # Core Developers FAQ
{:.no_toc} {:.no_toc}
This document lists frequently-asked questions and answers to technical This document lists frequently-asked questions by developers interested in working with Blockstack core components. If you are new to Blockstack, you should read the [general questions]({{site.baseurl}}/faqs/allFAQs.html) first.
questions about Blockstack. If you are new to Blockstack, you should read the
[genera questions](faqs/allFAQs) first. For more general questions about developing applications with the Blockstack platform, see the [DApp developer questions]({{site.baseurl}}/core/faq_developer.html).
If you have a technical question that gets frequently asked on the If you have a technical question that gets frequently asked on the
[forum](https://forum.blockstack.org) or [Slack](https://blockstack.slack.com), [forum](https://forum.blockstack.org) or [Slack](https://blockstack.slack.com),

12
_data/navigation_org.yml

@ -1,8 +1,14 @@
- title: About Blockstack - title: About Blockstack
docs: docs:
- org/overview - org/overview
- faqs/allFAQS
- org/token - org/token
- org/explore - org/explore
- title: Our Whitepapers
docs:
- org/whitepaper-blockchain
- org/whitepaper-tokensale
- org/whitepaper-token
- title: Manage Stacks - title: Manage Stacks
docs: docs:
- org/wallet-intro - org/wallet-intro
@ -10,13 +16,7 @@
- org/wallet-use - org/wallet-use
- org/tokenholders - org/tokenholders
- org/voucherholder - org/voucherholder
- title: Whitepapers
docs:
- org/whitepaper-blockchain
- org/whitepaper-tokensale
- org/whitepaper-token
- title: Reference - title: Reference
docs: docs:
- org/secureref - org/secureref
- faqs/allFAQS
- org/terms - org/terms

22
_org/overview.md

@ -2,21 +2,19 @@
layout: org layout: org
permalink: /:collection/:path.html permalink: /:collection/:path.html
--- ---
# What is the Blockstack Ecosystem # Overview of Blockstack
The Blockstack Ecosystem has a mission to bring a new internet where users Blockstack is a full-stack decentralized computing network that enables a new generation of applications where developers and users can interact fairly and securely. Blockstack uses blockchain technology to build protocols and developer tools designed to enable a fair and open Internet that returns digital rights to developers and consumers.
control the access to, and use of, their own identity and data. With this
mission in mind, three independent entities were formed:
* TOC
{:toc}
These three affiliated entities drive the advancement of the Blockstack mission. ## What is the Blockstack Ecosystem?
In this section, you learn about the mechanisms each entity uses to advance the
overall mission.
The Blockstack Ecosystem is the legal entities and community structures that support the Blockstack technology, the apps that rely on it, and the people that work with it. The ecosystem’s mission is to foster an open and decentralized Internet that establishes and protects privacy, security and freedom for all users.
## Blockstack Public Benefit Corp (PBC) The documentation on this site focuses on the technologies produced by three entities in the ecosystem.
### Blockstack Public Benefit Corp (PBC)
Blockstack Public Benefit Corp. (PBC) started development of the Blockstack Blockstack Public Benefit Corp. (PBC) started development of the Blockstack
platform in 2014 and launched an alpha of the platform in early 2017. The platform in 2014 and launched an alpha of the platform in early 2017. The
@ -38,11 +36,11 @@ Using Blockstack’s technology developers can start building immediately on the
blockchain with the knowledge you have today. You won’t need to spend time or blockchain with the knowledge you have today. You won’t need to spend time or
effort developing expertise in specialized languages or technologies. effort developing expertise in specialized languages or technologies.
## Blockstack Signature Fund ### Blockstack Signature Fund
{% include signature_fund.md %} {% include signature_fund.md %}
## Blockstack Token LLC ### Blockstack Token LLC
Through the 2017 Blockstack token offering, Blockstack Token LLC created the Through the 2017 Blockstack token offering, Blockstack Token LLC created the
Stacks token. This year's hard fork is an especially exciting milestone for the ecosystem because it distributes the first Stacks tokens to existing purchasers and recipients. This hard fork launches the Stacks blockchain v1, and enables the following two features for the Blockstack network: Stacks token. This year's hard fork is an especially exciting milestone for the ecosystem because it distributes the first Stacks tokens to existing purchasers and recipients. This hard fork launches the Stacks blockchain v1, and enables the following two features for the Blockstack network:

Loading…
Cancel
Save