ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 11:45:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

more ui content

Browse Source 
fix conflicts
This commit is contained in:
Jennifer Hasegawa
2018-04-26 14:13:26 -07:00
committed by mDuo13
parent 3e1619bf5c
commit 08906effec
19 changed files with 381 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
content/concept-consensus-network-landing.md Normal file
View File

@@ -0,0 +1,31 @@
# Consensus Network
<!--{# TODO: Are we learning about the Consensus Network or the Consensus Process? Both? Is one a child of the other -- or is the parent concept simply Consensus? Also, need to be careful to differentiate this content from the content we provide in Concepts > XRP Ledger Basics > Consensus. What should I expect to learn here - and how is it different from what I will learn there? #}-->
The primary role of consensus is for participants in the process to agree on which XRP Ledger transactions are to be processed as a group to resolve the double spend problem. This section covers concepts that help you learn the "what" and "why" behind fundamental aspects of consensus in the XRP Ledger.
* **[Consensus Principles and Rules](x)**
Understand the principles and rules involved in reaching consensus in the XRP Ledger, including some background on the double-spend problem and details about how consensus works.
<!--{# TODO: this language needs to be refined based on what we're actually focusing on here. Are these the principles and rules of consensus, the network, or the process? https://developers.ripple.com/concept-reaching-consensus.html #}-->
* **[Validators and the Trust Topology](x)**
<!--{# TODO: need this intro text - what is this about? What page does it link to? New content? #}-->
* **[Amendments](x)**
An amendment is a fully-functional feature or change, waiting to be enabled by the peer-to-peer network as a part of the consensus process. Understand the purpose of amendments and the amendment voting process.
<!--{# https://developers.ripple.com/concept-amendments.html #}-->
* **[Fee Voting](x)**
Fees include basic transaction costs as well as reserve requirements. Validators can vote for changes to fees. Understand the purpose and process of fee voting.
<!--{# https://developers.ripple.com/concept-fee-voting.html #}-->
* **[Pseudo-Transactions](x)**
Pseudo-transactions are never submitted by users, nor are they propagated through the network. Instead, a server may choose to inject them directly into a proposed ledger. If enough servers inject an equivalent pseudo-transaction for it to pass consensus, then it is included in the ledger. Understand the purpose and processing of pseudo-transactions.
<!--{# https://ripple.com/build/transactions/#pseudo-transactions #}-->
* **[Consensus White Papers](x)**
Access these Ripple white papers to get a close-up look at the XRP Ledger consensus algorithm.
<!--{# TODO: need to create this page of content #}-->

17
content/concept-rippled-landing.md Normal file
View File

@@ -0,0 +1,17 @@
# `rippled` Server
A `rippled` server is the core peer-to-peer server that manages the XRP Ledger. This section covers concepts that help you learn the "what" and "why" behind fundamental aspects of the `rippled` server.
* **[Server Modes](x)**
The `rippled` server can run in several different modes depending on its configuration, including stock, validating, and stand-alone. Understand the purpose of each mode and when to use each one.
<!--{# TODO: I removed Stand-Alone Mode as a peer to this section. Stand-Alone Mode is a server mode and should be covered in this concept. #}-->
* **[History Sharding](x)**
Historical sharding distributes the transaction history of the XRP Ledger into segments, called shards, across servers in the XRP Ledger network. Understand the purpose of history sharding and when to use it.
<!--{# TODO: Is this History Sharding or Historical Sharding? #}-->
* **[Clustering](x)**
If you are running multiple `rippled` servers in a single datacenter, you can configure those servers into a cluster to maximize efficiency. Understand the purpose of clustering and when to use it.

43
content/concept-xrp-ledger-basics-landing.md Normal file
View File

@@ -0,0 +1,43 @@
# XRP Ledger Basics
The XRP Ledger is an open-source, decentralized cryptographic ledger. This section covers basic concepts that help you learn the "what" and "why" behind fundamental aspects of the XRP Ledger.
<!--{# TODO: the title of this section is still in flux #}-->
* **[XRP Ledger Introduction](x)**
Get a quick and concise introduction to key features of the XRP Ledger.
<!--{# https://developers.ripple.com/concept-xrp-ledger-intro.html #}-->
* **[Consensus](x)**
Understand the role of consensus in the XRP Ledger.
<!--{# TODO: I believe this is https://developers.ripple.com/concept-consensus.html -- but need to be careful to differentiate this content from the content we provide in Concepts > Consensus Network. What should I expect to learn here - and how is it different from what I will learn there? Refine this intro sentence based on what we decide. #}-->
* **[Fees](x)**
Learn about the types of fees allowed by the XRP Ledger, including neutral fees (payable to no one) that protect the ledger against abuse, as well as fees that users can collect from each other.
<!--{# https://developers.ripple.com/concept-fees.html #}-->
* **[Money in the XRP Ledger](x)**
Understand how the XRP Ledger handles money. This includes XRP, as well as non-XRP currencies. Non-XRP currencies are represented as _issued currencies_ in the XRP Ledger.
<!--{# TODO: Note the XRP section below. It contains content from https://developers.ripple.com/concept-money.html -- not sure of where this article stops and the discussion of XRP itself should begin. #}-->
* **[Source and Destination Tags](x)**
Understand why and when to use these tags that indicate the source and destination of an XRP Ledger payment.
<!--{# https://ripple.com/build/gateway-guide/#source-and-destination-tags #}-->
* **[Transaction Authorization](x)**
Learn about transaction authorization methods available in the XRP Ledger.
<!--{# TODO: I think this is: https://developers.ripple.com/reference-transaction-format.html#authorizing-transactions #}-->
* **[Software Ecosystem](x)**
<!--{# TODO: Not sure what this is about #}-->
* **[XRP](x)**
<!--{# TODO: https://developers.ripple.com/concept-money.html#xrp -- but this is a subsection of Money in the XRP Ledger -- see above. Need to figure out where that article's discussion of XRP stops and where this one begins. Write the overview sentence once that is decided. #}-->
* **[FAQ](x)**
<!--{# TODO: I was thinking that we could host this article on the Dev Portal instead of on ripple.com as it is very technical and answers questions that our devs would have: https://ripple.com/technical-faq-xrp-ledger/ -- but we should coordinate with Marketing. It is currently accessed under the Support heading in the footer two links above access to the Dev Portal. #}-->

25
content/concepts.md Normal file
View File

@@ -0,0 +1,25 @@
# XRP Ledger Concepts
This section covers concepts that help you learn the "what" and "why" behind fundamental aspects of the XRP Ledger.
While XRP Ledger functionality is incredibly robust with equally vast number of possible use cases, here's a high-level view of four primary concepts that can help you understand the fundamentals of the XRP Ledger:
[![XRP Ledger concepts](img/xrp-ledger-concepts.png)](img/xrp-ledger-concepts.png)
<!--{# TODO: Just mocked this up quickly - thought having an EXTREMELY high-level graphic might help folks understand why these concepts matter and how they flow together at the HIGHEST level. May not be useful - or possible. LOL #}-->
* **[XRP Ledger Basics](x)**
<!--{# TODO: This section title is still in flux. Per Rome, must not be "XRP Ledger" - but perhaps "The Basics" or "XRP Ledger Basics"? #}-->
The XRP Ledger is a decentralized cryptographic ledger powered by a network of peer-to-peer `rippled` servers. The XRP Ledger is a shared, global ledger that is open to all and gives applications authoritative information about the state of its contents. Learn more about key concepts that will help you [understand the XRP Ledger](x).
* **[Payment System](x)**
One of the primary purposes of the XRP Ledger is payment processing. Whether based on XRP or issued currencies, the XRP Ledger payment system enables people to send and receive value. Learn more about the key concepts that will help you [understand the XRP Ledger payment system](x).
* **[rippled Server](x)**
A `rippled` server is the core peer-to-peer server that manages the XRP Ledger. Each `rippled` server connects to a network of peers, relays cryptographically signed transactions, and maintains a local copy of the complete shared global ledger. Anyone can run one. Learn more about key concepts that will help you [understand the `rippled` server](x).
* **[Consensus Network](x)**
The peer-to-peer XRP Ledger network consists of many distributed `rippled` servers that accept and process transactions. This network determines which transactions are applied to each new version of the ledger based on the consensus process. Learn about the concepts that will help you [understand the XRP Ledger consensus network](x).

27
content/dev-tools.md
View File

@@ -1,25 +1,28 @@
# Dev Tools
<!--{# TODO: Ensure that the list below follows the order of the left nav. #}-->
Ripple provides a set of developer tools to help you test, explore, and validate XRP Ledger API requests and behavior.
## [XRP Ledger Lookup Tool](xrp-ledger-rpc-tool.html)
Use this JSON-RPC-based debugging tool to print raw information about a XRP Ledger account, transaction, or ledger.
* **[XRP Ledger Lookup Tool](xrp-ledger-rpc-tool.html)**
## [XRP Ledger Test Net Faucet](xrp-test-net-faucet.html)
Use the WebSocket and JSON-RPC Test Net endpoints to test software built on the XRP Ledger without using real funds. Generate Test Net credentials and funds for testing purposes. Test net ledger and balances are reset on a regular basis.
Use this JSON-RPC-based debugging tool to print raw information about a XRP Ledger account, transaction, or ledger.
* **[XRP Ledger Test Net Faucet](xrp-test-net-faucet.html)**
Use the WebSocket and JSON-RPC Test Net endpoints to test software built on the XRP Ledger without using real funds. Generate Test Net credentials and funds for testing purposes. Test net ledger and balances are reset on a regular basis.
<!--{# TODO: For information about how to connect your `rippled` test server to the Test Net, see [XXXXX](x). #}-->
## [rippled API WebSocket Tool](websocket-api-tool.html)
Need to see the rippled API in action ASAP? Use this tool to send prepopulated sample requests and get responses. No setup required.
<!--{# which methods are surfaced here -- is this all of them? #}-->
* **[rippled API WebSocket Tool](websocket-api-tool.html)**
## [Data API v2 Tool](data-api-v2-tool.html)
Need to see the Data API v2 in action ASAP? Use this tool to send prepopulated sample requests and get responses. No setup required.
Need to see the rippled API in action ASAP? Use this tool to send prepopulated sample requests and get responses. No setup required.
<!--{# TODO: which methods are surfaced here -- is this all of them? #}-->
## [rippled.txt Validator](ripple-txt-validator.html)
Use this tool to verify that your `ripple.txt` is syntactically correct and deployed properly.
* **[Data API v2 Tool](data-api-v2-tool.html)**
## Other Information
Need to see the Data API v2 in action ASAP? Use this tool to send prepopulated sample requests and get responses. No setup required.
* **[rippled.txt Validator](ripple-txt-validator.html)**
Use this tool to verify that your `ripple.txt` is syntactically correct and deployed properly.
Have an idea for a tool not provided here? [Contact us >](mailto:docs@ripple.com)

18
content/news.md
View File

@@ -6,18 +6,20 @@ Get the latest XRP Ledger news and release information.
<!--{# area will eventually include a Network Health page #}-->
## Known Amendments
<!--{# TODO: see if the link to the content makes more sense in the bullet itself - moved the link there just to make this consistent across landing pages like Dev Tools and Use Cases. See how it looks and feels. #}-->
Amendments provide a way to introduce breaking changes to the decentralized XRP Ledger network without causing disruptions. Get the comprehensive list of [all known amendments](reference-amendments.html) and their statuses on the production XRP Ledger.
* **[Known Amendments](x)**
## Ripple Dev Blog
Amendments provide a way to introduce breaking changes to the decentralized XRP Ledger network without causing disruptions. Get the comprehensive list of [all known amendments](reference-amendments.html) and their statuses on the production XRP Ledger.
<a href="https://ripple.com/category/dev-blog/" target="_blank">Visit the Dev Blog <i class="fa fa-external-link"></i></a> <!--{#_ open link in new tab #}--> for the latest news and stories about the XRP Ledger and `rippled`.
* **<a href="https://ripple.com/category/dev-blog/" target="_blank">Ripple Dev Blog </a><i class="fa fa-external-link"></i><!--{#_ open link in new tab #}-->**
## Ripple Open Source Project Releases
Visit the Dev Blog for the latest news and stories about the XRP Ledger and `rippled`.
<a href="https://github.com/ripple" target="_blank">Visit the Ripple GitHub Organization <i class="fa fa-external-link"></i></a> <!--{#_ open link in new tab #}--> to access open source projects, including `rippled`, `ripple-lib`, and `ripple-libpp`.
* **<a href="https://github.com/ripple" target="_blank">Ripple GitHub Organization </a><i class="fa fa-external-link"></i><!--{#_ open link in new tab #}-->**
## Interledger
Visit the Ripple GitHub Organization to access open-source projects, including `rippled`, `ripple-lib`, and `ripple-libpp`.
<a href="https://interledger.org/" target="_blank">Learn about Interledger <i class="fa fa-external-link"></i></a> <!--{#_ open link in new tab #}-->, an open protocol suite for sending payments across different ledgers. The open architecture and minimal protocol enable interoperability for any value transfer system.
* **<a href="https://interledger.org/" target="_blank">Interledger </a><i class="fa fa-external-link"></i><!--{#_ open link in new tab #}-->**
Learn about Interledger, an open protocol suite for sending payments across different ledgers. The open architecture and minimal protocol enable interoperability for any value transfer system.

20
content/reference-rippled-api-admin-landing.md Normal file
View File

@@ -0,0 +1,20 @@
# Admin `rippled` Methods
Communicate directly with a `rippled` server using these admin API methods.
Admin methods are meant only for trusted personnel in charge of keeping the server operational. Admin methods include commands for managing, monitoring, and debugging the server.
Admin commands are available only if you connect to `rippled` on a host and port that the `rippled.cfg` file identifies as admin. By default, the commandline client uses an admin connection.
<!--{# TODO: add a link to a doc that specifically talks about how to set this config setting #}-->
* **[Key Generation Methods](x)**
<!--{# TODO: provide overview text of what this method type is all about #}-->
* **[Logging and Data Management Methods](x)**
<!--{# TODO: provide overview text of what this method type is all about #}-->
* **[Server Control Methods](x)**
<!--{# TODO: provide overview text of what this method type is all about #}-->
* **[Status and Debugging Methods](x)**
<!--{# TODO: provide overview text of what this method type is all about #}-->

5
content/reference-rippled-api-conventions-landing.md Normal file
View File

@@ -0,0 +1,5 @@
# `rippled` API Conventions
Get details about these common conventions used across the `rippled` API, including error formatting, basic data types, and `rippled` server states.
<!--{# TODO: Expand this content once we see the content in this section. #}-->

24
content/reference-rippled-api-landing.md Normal file
View File

@@ -0,0 +1,24 @@
# `rippled` API Reference
This section provides the following `rippled` API reference documentation:
* **[Public `rippled` API Methods](x)**
Public methods are not necessarily meant for the general public, but they are used by any client attached to the server. Think of public methods as being for members or customers of the organization running the server.
* **[Admin `rippled` API Methods](x)**
Admin methods are meant only for trusted server operators and include commands for managing, monitoring, and debugging the server. Think of admin methods as being for the personnel in charge of keeping the server operational.
* **[Transaction Formats](x)**
A transaction is the only way to modify the XRP Ledger. Get details about its required format.
* **[Ledger Data Formats](x)**
Learn about the format of individual ledgers that make up the shared, global XRP Ledger.
* **[API Conventions](x)**
<!--{# TODO: Should this come before Transaction Formats? It seems that you'll need this info to be able to make your first requests -- but once you know it, you won't really be accessing it all the time. #}-->
Get details about these common conventions used across the `rippled` API.

11
content/reference-rippled-api-ledger-data-format-landing.md Normal file
View File

@@ -0,0 +1,11 @@
# `rippled` Ledger Data Format
Learn about the format of individual ledgers that make up the shared, global XRP Ledger.
* **[Ledger Header](x)**
<!--{# TODO: provide overview text of what this content is all about #}-->
* **[Ledger Object Types](x)**
<!--{# TODO: provide overview text of what this content is all about #}-->
<!--{# TODO: This page may need to catch overflow of any doc from https://developers.ripple.com/reference-ledger-format.html#xrp-ledger-data-format that hasn't been moved out to Ledger Header and Ledger Object Type docsIf yes - need to adjust presentation of links to child pages above because they may look like anchor links to topics on the page and cause confusion. Ideally, we'd provide another page in this hierarchy that reflects the content in the overflow. #}-->

31
content/reference-rippled-api-public-landing.md Normal file
View File

@@ -0,0 +1,31 @@
# Public `rippled` Methods
Communicate directly with a `rippled` server using these public API methods.
Public methods are not necessarily meant for the general public, but they are used by any client attached to the server. Think of public methods as being for members or customers of the organization running the server.
Public methods include operations such as checking the state of the ledger, finding a path to connecting users, and submitting a transaction, among others.
* **[Account Methods](x)**
<!--{# TODO: provide overview text of what this method type is all about #}-->
* **[Ledger Methods](x)**
<!--{# TODO: provide overview text of what this method type is all about #}-->
* **[Path and Order Book Methods](x)**
<!--{# TODO: provide overview text of what this method type is all about #}-->
* **[Payment channel Methods](x)**
<!--{# TODO: provide overview text of what this method type is all about #}-->
* **[Transaction Methods](x)**
<!--{# TODO: provide overview text of what this method type is all about #}-->
* **[Subscription Methods](x)**
<!--{# TODO: provide overview text of what this method type is all about #}-->
* **[Server Info Methods](x)**
<!--{# TODO: provide overview text of what this method type is all about #}-->
* **[Utility Methods](x)**
<!--{# TODO: provide overview text of what this method type is all about #}-->

14
content/reference-rippled-api-transaction-format-landing.md Normal file
View File

@@ -0,0 +1,14 @@
# `rippled` Transaction Formats
A transaction is the only way to modify the XRP Ledger. Get details about its required format.
* **[Transaction Common Fields](x)**
<!--{# TODO: provide overview text of what this content is all about #}-->
* **[Transaction Types](x)**
<!--{# TODO: provide overview text of what this content is all about #}-->
* **[Transaction Results](x)**
<!--{# TODO: provide overview text of what this content is all about #}-->
<!--{# TODO: This page may need to catch overflow of any doc from https://developers.ripple.com/reference-transaction-format.html that hasn't been moved out to other docs, such as tutorials and more granular reference docs. If yes - need to adjust presentation of links to child pages above because they may look like anchor links to topics on the page and cause confusion. Ideally, we'd provide another page in this hierarchy that reflects the content in the overflow. #}-->

6
content/references.md
View File

@@ -2,7 +2,7 @@
## [`rippled` API Reference](x)
<!--{# provide link to PDF #}-->
Use the `rippled` API to communicate with a rippled server, the core peer-to-peer server that manages the XRP Ledger.
Use the `rippled` API to communicate with a `rippled` server, the core peer-to-peer server that manages the XRP Ledger.
### [Public `rippled` API Methods](x)
Communicate directly with a `rippled` server using these public API methods.
@@ -39,7 +39,3 @@ Official client library to the XRP Ledger. Available for JavaScript only.
Access info about changes to the XRP Ledger, including transaction history and analytics.
<!--{# content populated based on hierarchy and template #}-->
<!--stackedit_data:
eyJoaXN0b3J5IjpbNTk0MDQ2NzBdfQ==
-->

20
content/tutorial-get-started-landing.md Normal file
View File

@@ -0,0 +1,20 @@
# Get Started
Get up and running with some of the key tools you'll use to work with the XRP Ledger.
* **[Get Started with the `rippled` API](x)**
Learn how to make your first requests to the `rippled` API using our WebSocket and JSON-RPC interfaces. We'll also show you how to make requests to the command line interface, which is not officially supported, but which can be useful for testing and development.
* **[Get Started with `ripple-lib` for JavaScript](x)**
Learn how to make your first requests to `ripple-lib` (aka RippleAPI), a JavaScript API for accessing the XRP Ledger using Node.js and a browser. `ripple-lib` is the official client library of the XRP Ledger.
<!--{# TODO: Need to refine this language -- but the point is that we need to disambiguate ripple-lib, RippleAPI, and rippled API. When you're new (and even if you just haven't used the material in a while) -- to understand the difference between these three very similarly named and related techs. #}-->
* **[Get Started with the Data API v2](x)**
Learn how to make your first calls to the Ripple Data API v2, which provides access to information about changes in the XRP Ledger, including transaction history and processed analytical data.
<!--{# TODO: It would be great to more clearly define the use case for this API vs the rippled API. You could get some of the same info from either -- but what differentiates the Data API? When would I want to call this one vs rippled API? I know it has to do with transactional data and processed data -- but what is the common use case? #}-->
* **[Get Started with Dev Tools](x)**
Learn how and when to use each of our Dev Tools, including the XRP Ledger Test Net and other tools that enable you make requests to our APIs from your browser.

27
content/tutorial-landing.md Normal file
View File

@@ -0,0 +1,27 @@
# Tutorials
These tutorials walk you step-by-step through performing key and common tasks with the XRP Ledger.
* **[Get Started](x)**
Get up and running with some of the resources you'll use to work with the XRP Ledger, such as the `rippled` API, the `ripple-lib` API for JavaScript, and the XRP Ledger Test Net.
* **[Manage Account Settings](x)**
<!--{# TODO: this text below is written to reflect that we've moved "Create an Account" from the "Send the Receive Money" section below - to this section. If this section is called "Manage Account Settings" - I think the first tutorial needs to be creating an account, so that you can then configure settings for it. #}-->
Create an XRP Ledger account and configure it to send and receive payments the way you want it to.
* **[Send and Receive Money](x)**
After you have a configured XRP Ledger account, learn how to sign, submit, and receive transactions using your account.
* **[Work with Exchanges](x)**
<!--{# TODO: the title of this tutorial group may change. May be clearer to surface the two tutorial types separately? #}-->
Learn how to list XRP in your exchange. Also, learn how to use the decentralized exchange functionality provided by the XRP Ledger.
* **[Manage the `rippled` Server](x)**
Build or install and run a `rippled` server. Configure `rippled` to run in various modes, such as validator, stock, and standalone. Also, learn how to troubleshoot `rippled`.
Want a tutorial about a task not covered here? [Contact us >](mailto:docs@ripple.com)

25
content/tutorial-manage-acct-settings-landing.md Normal file
View File

@@ -0,0 +1,25 @@
# Manage Account Settings
<!--{# TODO: updated this tutorial section to include account creation -- which was in the Send and Receive Money tutorials section. I did this because to manage account settings - you need an account first. Seems to flow better? Or we can say before you can use these tutorials, you must create an account - see the related tutorial section in Send and Receive Money. #}-->
Create an XRP Ledger account and configure it to send and receive payments the way you want it to.
* **[Create an XRP Ledger Account](x)**
Learn how to generate and fund an XRP Ledger address to create an XRP Ledger account.
* **[Set Up Your Account to Work with a Regular Key Pair](x)**
Learn how to set up your account to use a regular key pair to sign transactions. Unlike with the private key of your primary key pair, if the private key of your regular key pair is compromised, you can remove or replace it without changing the rest of your account and having to re-establishing its relationships to other accounts.
* **[Set Up Issuing and Operational Addresses for Your Account](x)**
Learn how to set up your account with multiple XRP Ledger addresses to be used strategically to minimize the risk associated with a compromised secret key.
* **[Set Up Your Account to Use Issued Currencies](x)**
Learn how to set up your account to use issued currencies, including how to set the `NoRipple` flag and require authorization for users to hold balances issued by this account.
* **[Set Up Your Account to Use XRP](x)**
Learn how to set up your account to use XRP, including how to enable deposit authorization, which strictly rejects any incoming money from transactions sent by other accounts.
<!--{# TODO: the doc for this setting says: This includes transfers of XRP and issued currencies. So, is this one needs to go in that "third bucket" that applies to both XRP and issued currencies? Or is this a setting only for XRP accounts that stops it from holding issued currencies? #}-->

37
content/tutorial-rippled-landing.md Normal file
View File

@@ -0,0 +1,37 @@
# Manage the `rippled` Server
<!--{# There may be a better way to present the info on this page - especially once we have more tutorials per platform. Also, how about the sequence -- which tasks are required/commonly performed/highest priority? Which tasks are advanced/optional/lower priority? #}-->
The tutorials in this section walk you through the ins-and-outs of maintaining a `rippled` server.
* **[Install `rippled`](x)**
Install `rippled` from a binary executable on CentOS/RedHat and Ubuntu.
* **[Build and Run `rippled` on Ubuntu](x)**
Build `rippled` from source and run it on Ubuntu.
* **[Configure and Scale `rippled`](x)**
Configure and scale your `rippled` to meet the needs of your use case, whether you need a test server or a robust production-grade server.
* **[Run `rippled` in Validator Mode](x)**
Configure `rippled` to run in validator mode. In this mode, your `rippled` server participates in the XRP Ledger consensus process.
* **[Run `rippled` in Stand-Alone Mode](x)**
Configure `rippled` to run in stand-alone mode. In this mode, your `rippled` server is not connected to the live XRP Ledger network, which is a great mode to use for testing and development.
* **[Run `rippled` in a Cluster](x)**
Run `rippled` in a cluster to maximize efficiency.
* **[Troubleshoot `rippled`](x)**
Troubleshoot your `rippled`, whether you are just trying to get it running, or if it's been up and running for a while.
* **[Configure the Peer Protocol](x)**
Configure your `rippled` to use the peer protocol to send and receive connections on the peer port.
<!--{# TODO: Not sure about this phrasing -- wondering if this should just be a part of the "Configure and Scale" rippled.cfg tutorial? #}-->

17
content/tutorial-work-with-exchanges-landing.md Normal file
View File

@@ -0,0 +1,17 @@
# Work with Exchanges
<!--{# TODO: I think this section is in flux #}-->
The tutorials in this section cover integrations from exchanges to the XRP Ledger, as well as how to use the decentralized exchange functionality provided by the XRP Ledger.
* **[List XRP in Your Exchange](x)**
Want to list XRP in your exchange?
Use this tutorial to learn about this integration between your exchange and the XRP Ledger. This includes learning how to deposit XRP into an exchange, trade XRP on an exchange, rebalance XRP holdings in an exchange, and withdraw XRP from an exchange.
* **[Become an Issuing Gateway on the XRP Ledger Decentralized Exchange](x)**
<!--{# TODO: Is this an accurate heading? I want the heading to make the connection between "issuing gateway" and "decentralized exchange." Also, seems that you can also run a private exchange using the XRP Ledger Decentralized Exchange - add a tutorial later? #}-->
Want to become an issuing gateway using the decentralized exchange functionality provided by the XRP Ledger?
Use this tutorial to learn about this integration between a gateway and the XRP Ledger. This includes learning how to meet compliance rules, as well as how to send transactions from a gateway to the XRP Ledger and from the XRP Ledger to a gateway.

16
content/use-cases.md
View File

@@ -4,23 +4,23 @@ Use these roadmaps to walk you, task-by-task, through implementing your use case
Here are some of our users' most popular use cases:
## [List XRP in My Exchange](tutorial-listing-xrp.html)
* **[List XRP in My Exchange](tutorial-listing-xrp.html)**
Integrate with the XRP Ledger to be able to list XRP in your exchange, enabling your users to deposit and withdraw XRP.
Integrate with the XRP Ledger to be able to list XRP in your exchange, enabling your users to deposit and withdraw XRP.
## [Provide Liquidity in the XRP Ledger](#)
* **[Provide Liquidity in the XRP Ledger](x)**
<!--{# TODO: link #}-->
Integrate with the XRP Ledger to place offers algorithmically or through your own custom trading interface, providing liquidity between different gateways and their users.
Integrate with the XRP Ledger to place offers algorithmically or through your own custom trading interface, providing liquidity between different gateways and their users.
## [Contribute Code to `rippled`](#)
* **[Contribute Code to `rippled`](x)**
<!--{# TODO: link #}-->
Help us improve the open source reference server implementation of `rippled`, the server that is the core of the XRP Ledger peer-to-peer network.
Help us improve the open source reference server implementation of `rippled`, the server that is the core of the XRP Ledger peer-to-peer network.
## [Maintain rippled Servers](#)
* **[Maintain rippled Servers](x)**
<!--{# TODO: link #}-->
Learn how to install, run, and maintain a `rippled` server, whether you need a stock server, test server, or robust production validator.
Learn how to install, run, and maintain a `rippled` server, whether you need a stock server, test server, or robust production validator.
Want to see a roadmap for a case not listed here? [Contact us >](mailto:docs@ripple.com)