This repository was archived by the owner on Jun 22, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 251
WIP: General site reorganization #134
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
236ed05
Change tools page to list all components
Mr0grog 8b3024c
Moving docs around between the different parts of "learn"
Mr0grog b9ca831
Merge branch 'master' of https://github.com/stellar/docs into nav-res…
Mr0grog 0add147
Split "tools" into "tools" and "software" (e.g. core, horizon, federa…
Mr0grog 76924e3
Move things-to-build under guides
Mr0grog 25ca850
Retitle things-to-build to "build stellar apps"
Mr0grog 7689d3c
New network overview text from Google doc.
Mr0grog 09d23d4
Remove paragraph about needing a regionally local core.
Mr0grog 0abc1d9
Add `contributing` document to guides.
Mr0grog a44e25d
Move integration-guides section up a level.
Mr0grog 81d23c8
Merge branch 'master' into nav-restructure
irisli File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Anchor Guide | ||
title: Become an Anchor | ||
--- | ||
|
||
# Becoming a Stellar Anchor | ||
|
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
title: Contributing | ||
--- | ||
|
||
# How to contribute to a Stellar project | ||
|
||
Your contributions to the Stellar network will help improve the world’s financial | ||
infrastructure, faster. | ||
|
||
We want to make it as easy as possible to contribute changes that | ||
help the Stellar network grow and thrive. There are a few guidelines that we | ||
ask contributors to follow so that we can merge your changes quickly. | ||
|
||
## Getting Started | ||
|
||
* Make sure you have a [GitHub account](https://github.com/join) | ||
* Create a GitHub issue for your contribution, assuming one does not already exist. | ||
* Clearly describe the issue including steps to reproduce if it is a bug. | ||
* Fork the repository on GitHub | ||
|
||
## Finding things to work on | ||
|
||
The first place to start is always looking over the current github issues for the project you are interested in contributing to. Issues marked with [help wanted](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Astellar+label%3A%22help+wanted%22) are usually pretty self contained and a good place to get started. | ||
|
||
Stellar.org also uses these same github issues to keep track of what we are working on. If you see any issues that are assigned to a particular person or have the `in progress` label, that means someone is currently working on that issue. The `orbit` label means we will likely be working on this issue in the next week or two. The `ready` label means that the issue is one we have prioritized and will be working on in our next orbit (stellar term for sprint) or two. | ||
|
||
Feel free to make your own issues if you think something needs to added or fixed. | ||
|
||
## Making Changes | ||
|
||
* Create a topic branch from where you want to base your work. | ||
* This is usually the master branch. | ||
* Please avoid working directly on the `master` branch. | ||
* Make sure you have added the necessary tests for your changes and make sure all tests pass. | ||
|
||
## Submitting Changes | ||
|
||
* [Sign the Contributor License Agreement](https://docs.google.com/forms/d/1g7EF6PERciwn7zfmfke5Sir2n10yddGGSXyZsq98tVY/viewform?usp=send_form) | ||
* All content, comments, and pull requests must follow the [Stellar Community Guidelines](https://www.stellar.org/community-guidelines/). | ||
* Push your changes to a topic branch in your fork of the repository. | ||
* Submit a pull request to the repository for the project you’re working on in the Stellar organization. | ||
* Include a descriptive [commit message](https://github.com/erlang/otp/wiki/Writing-good-commit-messages). | ||
* Changes contributed via pull request should focus on a single issue at a time. | ||
* Rebase your local changes against the master branch. Resolve any conflicts that arise. | ||
|
||
At this point you're waiting on us. We like to at least comment on pull requests within three | ||
business days (typically, one business day). We may suggest some changes, improvements or alternatives. | ||
|
||
## Minor Changes | ||
|
||
### Documentation | ||
For small changes to comments and documentation, it is not | ||
always necessary to create a new GitHub issue. In this case, it is | ||
appropriate to start the first line of a commit with 'doc' instead of | ||
an issue number. | ||
|
||
# Additional Resources | ||
* [Contributor License Agreement](https://docs.google.com/forms/d/1g7EF6PERciwn7zfmfke5Sir2n10yddGGSXyZsq98tVY/viewform?usp=send_form) | ||
* [Explore the API](https://www.stellar.org/developers/learn/) | ||
* #dev channel on [Slack](http://slack.stellar.org) | ||
* #stellar-dev IRC channel on freenode.org | ||
|
||
|
||
This document is inspired by: | ||
|
||
https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md | ||
|
||
https://github.com/thoughtbot/factory_girl_rails/blob/master/CONTRIBUTING.md | ||
|
||
https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Exchange Guide | ||
title: Set Up an Exchange | ||
--- | ||
|
||
# Adding Stellar to your Exchange | ||
|
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
title: The Stellar Network | ||
--- | ||
 | ||
|
||
Using the Stellar network, you can build mobile wallets, banking tools, smart devices that pay for themselves, and just about anything else you can dream up involving payments! Even though Stellar is a complex distributed system, working with it doesn’t need to be complicated. | ||
|
||
## API: Horizon | ||
|
||
**Most applications interact with the Stellar network through [Horizon](../../horizon/learn),** a RESTful HTTP API server. Horizon gives you a straightforward way to submit transactions, check accounts, and subscribe to events. Because it’s just HTTP, you can communicate with Horizon using your web browser, simple command line tools like cURL, or the Stellar SDK for your favorite programming language. | ||
|
||
Stellar.org maintains [JavaScript](), [Java](), and [Go]()-based SDKs for communicating with Horizon. There are also community-maintained SDKs for [Ruby](), [Python](), and [C#](). | ||
|
||
## Network Backbone: Stellar Core | ||
|
||
Behind the scenes, every Horizon server connects to **[Stellar Core](../../stellar-core/learn/admin.html), the backbone of the Stellar network.** The Stellar Core software does the hard work of validating and agreeing on the status of every transaction with other instances of Core through the Stellar Consensus Protocol (SCP). The Stellar network itself is a collection of connected Stellar Cores run by various individuals and entities around the world. Some instances have a Horizon server you can communicate with, while others exist only to add reliability to the overall network. | ||
|
||
You might want to host your own instance of Stellar Core in order to submit transactions without depending on a third party, have more control over who to trust, or simply to help make the Stellar network more reliable and robust for others. | ||
|
||
## Big Picture: The Stellar Network | ||
|
||
The Stellar network is a worldwide collection of Stellar Cores, each maintained by different people and organizations. The distributed nature of the network makes it reliable and safe. | ||
|
||
All these Stellar Cores—the network of nodes—eventually agree on a set of transactions. Each transaction on the network costs a small fee: 100 stroops (0.00001 <abbr title="Lumens">XLM</abbr>) This fee helps prevent bad actors from spamming the network. | ||
|
||
To help you test your tools and applications, Stellar.org operates a small test network and Horizon instance. [Get started with the testnet.](../concepts/test-net.html) | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
title: Sending and Receiving Money | ||
--- | ||
[placeholder] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,12 @@ | ||
Build cool things on Stellar! This list outlines a few ideas for applications. Feel free to add your own or take one here and run with it. | ||
--- | ||
title: Build Stellar Apps | ||
--- | ||
Build cool things on Stellar! This list outlines a few ideas for applications. Feel free to add your own or take one here and run with it. | ||
As always, if you need help building anything with Stellar, just ask us ([Slack chat](http://slack.stellar.org/)),[IRC](https://kiwiirc.com/client/irc.freenode.net/#stellar-dev), or [email protected]) . | ||
|
||
If you're not looking for a full-blown project but still want to help out, look for `help wanted` issue labels in any of our [repos](https://github.com/stellar). | ||
|
||
# Slack Bot | ||
# Slack Bot | ||
- Report a stream of all stellar transactions to a channel. | ||
- *Advanced*: Allow people to send money/points/+1's to other Slack team members `/send @bob $5`. | ||
|
||
|
@@ -32,7 +35,7 @@ Allow anyone to send lumens from their Stellar client to any email address. They | |
|
||
This would be a service hosted at `domain.com` that does the following: | ||
- Runs a federation server. | ||
- Will federate payment addresses with an email prefix like `[email protected]*domain.com`. | ||
- Will federate payment addresses with an email prefix like `[email protected]*domain.com`. | ||
- If there is a federation request for an address you don't know that starts with a valid email address: | ||
- Generate a key pair | ||
- return the generated public key as the accountID | ||
|
@@ -46,7 +49,7 @@ This would be a service hosted at `domain.com` that does the following: | |
Let's say you have a public-facing service, perhaps for streaming or open wifi. You want to allow other people to use this service if they pay you small amounts. These payments could be used as spam prevention or to support your business. This is a job for the **toll collector**... | ||
|
||
## Toll Collector | ||
A simple service that keeps track of any XLM sent to a `toll address`. The toll collector has a database of public keys and amounts of XLM it has sent to the toll address. It watches for payments to the toll address on the Stellar network and adds them to this DB. | ||
A simple service that keeps track of any XLM sent to a `toll address`. The toll collector has a database of public keys and amounts of XLM it has sent to the toll address. It watches for payments to the toll address on the Stellar network and adds them to this DB. | ||
|
||
The toll collector service has one RPC or endpoint that you can call: | ||
|
||
|
@@ -67,7 +70,7 @@ Ideally the multisig coordinator includes the following features: | |
- Create a tx that you would like to be signed by multiple parties | ||
- Enter the public keys that you would like to sign the tx | ||
- If any of these keys have previously associated their email address, then they will be sent a message | ||
- When you come to the site you see a list of all pending transactions: | ||
- When you come to the site you see a list of all pending transactions: | ||
- You can see the details of each transaction | ||
- You can see who initiated the transaction | ||
- You can see who else has signed the transaction | ||
|
@@ -84,7 +87,7 @@ A web page that shows the state of the network quorum graph. Ideally the quorum | |
|
||
You should be able to view the quorum graph from the point of view of any given validator. You would probably need to run stellar-core to build the quorum monitor. You can get the data from the stellar-core logs and the /quorum command. | ||
|
||
*Advanced*: Build a server that connects to stellar-core and monitors the externalized messages and the various validator broadcasts. | ||
*Advanced*: Build a server that connects to stellar-core and monitors the externalized messages and the various validator broadcasts. | ||
|
||
# Libraries | ||
Build a library in your favorite language: | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: Stellar Software | ||
--- | ||
# Software | ||
|
||
Pre-built software and services you can run on your own infrastructure, provided by Stellar.org. | ||
|
||
## [Stellar Core](../stellar-core/learn/admin.html) | ||
Stellar Core is the backbone of the Stellar network and does the hard work of validating and agreeing on the status of every transaction with other instances of Core through the Stellar Consensus Protocol (SCP). | ||
|
||
## [Horizon](https://github.com/stellar/horizon) | ||
Horizon is the client-facing API server for the Stellar ecosystem. It acts as the interface between Stellar Core and applications that want to access the Stellar network. If you are running Stellar Core, you will probably also want to run Horizon. | ||
|
||
## [Federation Server](https://github.com/stellar/federation) | ||
Go implementation of Federation protocol server. This federation server is designed to be dropped in to your existing infrastructure. It can be configured to pull the data it needs out of your existing DB. | ||
|
||
## [Bridge Server](https://github.com/stellar/bridge-server) | ||
Stellar’s Bridge server is an easier-to-use version of Horizon, meant to simplify compliance operations and other more complicated integrations. Because it stores and manages keys and account information, access to it should be well protected. Unlike Horizon, it should never be exposed to the public internet. | ||
|
||
## [Archivist](https://github.com/stellar/archivist) | ||
This is a small tool, written in Go, for working with stellar-core history archives directly. It is a standalone tool that does not require stellar-core, or any other programs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,16 @@ | ||
--- | ||
title: Tools Overview | ||
title: Stellar Tools | ||
--- | ||
# [Laboratory](https://www.stellar.org/laboratory) | ||
# Tools | ||
|
||
## [Laboratory](https://www.stellar.org/laboratory) | ||
Interactive way to learn the Stellar API. The source is available [here](https://github.com/stellar/laboratory). | ||
|
||
# [Account Viewer](https://www.stellar.org/account-viewer/) | ||
|
||
# Reference applications and sample code | ||
|
||
## [Account Viewer](https://github.com/stellar/account-viewer) | ||
Check your balance and send simple payments. This basic client is built on top of [Interstellar](https://github.com/stellar/interstellar) and connects to the live Stellar network. The source is available [here](https://github.com/stellar/account-viewer). | ||
|
||
## [SMS Client](https://github.com/stellar/stellar-sms-client) | ||
This is a demo of Stellar SMS Client. It was originally developed during Stellar Hack Day. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jessica-collier: @irisli suggested the page title and overview here could be a little better and more descriptive. (we probably don’t need the H1 at all)