From 1b16b460b6a8c73f9cebfe5c02303e457934fa61 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Wed, 31 Jul 2019 17:14:21 -0700 Subject: [PATCH] IA: add more interlinking / 'See Also' to concepts --- .../concepts/consensus-network/consensus.md | 7 +++++++ .../decentralized-exchange/autobridging.md | 8 ++++--- .../concepts/decentralized-exchange/offers.md | 12 +++++++++++ .../decentralized-exchange/ticksize.md | 5 ++++- .../concepts/the-rippled-server/clustering.md | 11 +++++++++- .../ledger-history/history-sharding.md | 15 ++++++++++--- .../ledger-history/ledger-history.md | 18 ++++++++++++++++ .../ledger-history/online-deletion.md | 21 ++++++++++++++----- .../the-rippled-server/peer-protocol.md | 14 +++++++++++++ .../rippled-server-modes.md | 17 ++++++++++++++- .../transaction-censorship-detection.md | 11 ++++++++++ 11 files changed, 125 insertions(+), 14 deletions(-) diff --git a/content/concepts/consensus-network/consensus.md b/content/concepts/consensus-network/consensus.md index 31029d76a4..e095075fd0 100644 --- a/content/concepts/consensus-network/consensus.md +++ b/content/concepts/consensus-network/consensus.md @@ -176,6 +176,7 @@ Best practices for applications submitting transactions include: - [consensus_info method][] - [validator_list_sites method][] - [validators method][] + - [consensus_info method][] @@ -202,3 +203,9 @@ Best practices for applications submitting transactions include: 9 – In practice, the XRP Ledger runs more efficiently by starting a new round of consensus concurrently, before validation has completed. 10 – A `rippled` server can respond to API requests even without a complete ledger history. Interruptions in service or network connectivity can lead to missing ledgers, or gaps, in the server’s ledger history. Over time, if configured to, `rippled` fills in gaps in its history. When testing for missing transactions, it is important to verify against a server with continuous complete ledgers from the time the transaction was submitted until its LastLedgerSequence. Use the RPC server_state to determine which complete_ledgers are available to a particular server. + + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/content/concepts/decentralized-exchange/autobridging.md b/content/concepts/decentralized-exchange/autobridging.md index 8347922edc..c0c400223a 100644 --- a/content/concepts/decentralized-exchange/autobridging.md +++ b/content/concepts/decentralized-exchange/autobridging.md @@ -1,13 +1,15 @@ # Auto-Bridging -Any OfferCreate that would exchange two non-XRP currencies could potentially use XRP as an intermediary currency in a synthetic order book. This is because of auto-bridging, which serves to improve liquidity across all currency pairs by using XRP as a vehicle currency. This works because of XRP's nature as a native cryptocurrency to the XRP Ledger. Offer execution can use a combination of direct and auto-bridged offers to achieve the best total exchange rate. +Any [Offer](offers.html) in the XRP Ledger's [decentralized exchange](decentralized-exchange.html) that would exchange two non-XRP currencies could potentially use [XRP](xrp.html) as an intermediary currency in a synthetic order book. This is because of _auto-bridging_, which serves to improve liquidity across all currency pairs by using XRP when doing so is cheaper than trading those currencies directly. This works because of XRP's nature as a native cryptocurrency to the XRP Ledger. Offer execution can use a combination of direct and auto-bridged offers to achieve the best total exchange rate. -Example: _Anita places an offer to sell GBP and buy BRL. She might find that this uncommon currency market has few offers. There is one offer with a good rate, but it has insufficient quantity to satisfy Anita's trade. However, both GBP and BRL have active, competitive markets to XRP. Auto-bridging software finds a way to complete Anita's offer by purchasing XRP with GBP from one trader, then selling the XRP to another trader to buy BRL. Anita automatically gets the best rate possible by combining the small offer in the direct GBP:BRL market with the better composite rates created by pairing GBP:XRP and XRP:BRL offers._ +Example: _Anita places an offer to sell GBP and buy BRL. She might find that this uncommon currency market has few offers. There is one offer with a good rate, but it has insufficient quantity to satisfy Anita's trade. However, both GBP and BRL have active, competitive markets to XRP. The XRP Ledger's auto-bridging system finds a way to complete Anita's offer by purchasing XRP with GBP from one trader, then selling the XRP to another trader to buy BRL. Anita automatically gets the best rate possible by combining the small offer in the direct GBP:BRL market with the better composite rates created by pairing GBP:XRP and XRP:BRL offers._ -Auto-bridging happens automatically on any OfferCreate transaction. [Payment transactions](payment.html) _do not_ autobridge by default, but path-finding can find paths that have the same effect. +Auto-bridging happens automatically on any [OfferCreate transaction][]. [Payment transactions](payment.html) _do not_ autobridge by default, but path-finding can find [paths](paths.html) that have the same effect. ## See Also - [Dev Blog: Introducing Autobridging](https://xrpl.org/blog/2014/introducing-offer-autobridging.html) - [Offer Preference](offers.html#offer-preference) + +- [Payment Paths](paths.html) diff --git a/content/concepts/decentralized-exchange/offers.md b/content/concepts/decentralized-exchange/offers.md index c9d196c720..32465f0940 100644 --- a/content/concepts/decentralized-exchange/offers.md +++ b/content/concepts/decentralized-exchange/offers.md @@ -68,6 +68,18 @@ You can determine the final disposition of an offer with an `Expiration` as soon If an OfferCreate transaction has an `Expiration` time that has already passed when the transaction first gets included in a ledger, the transaction does not execute the offer. The result code of such a transaction depends on whether the [Checks amendment][]:not_enabled: is enabled. With the Checks amendment enabled, the transaction has the `tecEXPIRED` result code. Otherwise, the transaction has the `tesSUCCESS` transaction code. In either case, the transaction has no effect except to destroy the XRP paid as a [transaction cost](transaction-cost.html). +## See Also + +- **Concepts:** + - [Issued Currencies Overview](issued-currencies-overview.html) + - [Paths](paths.html) +- **Tutorials:** + - [List Your Exchange on XRP Charts](list-your-exchange-on-xrp-charts.html) - for off-ledger exchanges +- **References:** + - [account_offers method][] + - [book_offers method][] + - [OfferCreate transaction][] + - [Offer object](offer.html) {% include '_snippets/rippled-api-links.md' %} diff --git a/content/concepts/decentralized-exchange/ticksize.md b/content/concepts/decentralized-exchange/ticksize.md index 66ed58168d..dbfee43983 100644 --- a/content/concepts/decentralized-exchange/ticksize.md +++ b/content/concepts/decentralized-exchange/ticksize.md @@ -13,8 +13,11 @@ When an issuer enables, disables, or changes the `TickSize`, Offers that were pl ## See Also - [Dev Blog: Introducing the TickSize Amendment](https://xrpl.org/blog/2017/ticksize-voting.html#ticksize-amendment-overview) +- **References:** + - [AccountSet transaction][] + - [book_offers method][] + - [CreateOffer transaction][] -- [AccountSet transaction][] diff --git a/content/concepts/the-rippled-server/clustering.md b/content/concepts/the-rippled-server/clustering.md index 7a12e784dd..e9d4c8b6aa 100644 --- a/content/concepts/the-rippled-server/clustering.md +++ b/content/concepts/the-rippled-server/clustering.md @@ -8,7 +8,16 @@ If you are running multiple `rippled` servers in a single datacenter, you can co If you are running a validator as a [private peer](peer-protocol.html#private-peers), Ripple recommends using a cluster of `rippled` servers as proxy servers. -For a tutorial on how to set up your servers in a cluster, see [Cluster `rippled` Servers](cluster-rippled-servers.html). +## See Also + +- **Tutorials:** + - [Cluster `rippled` Servers](cluster-rippled-servers.html) + - [Run rippled as a Validator](run-rippled-as-a-validator.html) +- **References:** + - [peers method][] + - [connect method][] + - [Peer Crawler](peer-crawler.html) + {% include '_snippets/rippled-api-links.md' %} diff --git a/content/concepts/the-rippled-server/ledger-history/history-sharding.md b/content/concepts/the-rippled-server/ledger-history/history-sharding.md index 07d8130801..29a5b87932 100644 --- a/content/concepts/the-rippled-server/ledger-history/history-sharding.md +++ b/content/concepts/the-rippled-server/ledger-history/history-sharding.md @@ -26,9 +26,18 @@ The history of all ledgers is shared by servers agreeing to keep particular rang ## See Also -- [Configure History Sharding](configure-history-sharding.html) -- [download_shard method][] -- [crawl_shards method][] +- **Concepts:** + - [Ledgers](ledgers.html) + - [Introduction to Consensus](intro-to-consensus.html) +- **Tutorials:** + - [Capacity Planning](capacity-planning.html) + - [Configure `rippled`](configure-rippled.html) + - [Configure History Sharding](configure-history-sharding.html) +- **References:** + - [crawl_shards method][] + - [download_shard method][] + - [Peer Crawler](peer-crawler.html) + {% include '_snippets/rippled-api-links.md' %} diff --git a/content/concepts/the-rippled-server/ledger-history/ledger-history.md b/content/concepts/the-rippled-server/ledger-history/ledger-history.md index 3181c128d6..e76d5ca6ea 100644 --- a/content/concepts/the-rippled-server/ledger-history/ledger-history.md +++ b/content/concepts/the-rippled-server/ledger-history/ledger-history.md @@ -50,6 +50,24 @@ Online deletion **does not** delete from the shard store. However, if you config For more information, see [Configure History Sharding](configure-history-sharding.html). +## See Also + +- **Concepts:** + - [Ledgers](ledgers.html) + - [Introduction to Consensus](intro-to-consensus.html) +- **Tutorials:** + - [Configure `rippled`](configure-rippled.html) + - [Configure Online Deletion](configure-online-deletion.html) + - [Configure Advisory Deletion](configure-advisory-deletion.html) + - [Configure History Sharding](configure-history-sharding.html) + - [Configure Full History](configure-full-history.html) +- **References:** + - [ledger method][] + - [server_info method][] + - [ledger_request method][] + - [can_delete method][] + - [ledger_cleaner method][] + {% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} diff --git a/content/concepts/the-rippled-server/ledger-history/online-deletion.md b/content/concepts/the-rippled-server/ledger-history/online-deletion.md index 5ec0f0939d..50c37d6ae6 100644 --- a/content/concepts/the-rippled-server/ledger-history/online-deletion.md +++ b/content/concepts/the-rippled-server/ledger-history/online-deletion.md @@ -109,11 +109,22 @@ When it comes time for online deletion, the server first walks through the oldes ## See Also -- [Capacity Planning](capacity-planning.html) -- [can_delete method][] - API reference documentation -- [Configure Online Deletion](configure-online-deletion.html) -- [Configure Advisory Deletion](configure-advisory-deletion.html) -- [Configure Full History](configure-full-history.html) +- **Concepts:** + - [Ledgers](ledgers.html) + - [Introduction to Consensus](intro-to-consensus.html) +- **Tutorials:** + - [Capacity Planning](capacity-planning.html) + - [Configure `rippled`](configure-rippled.html) + - [Configure Online Deletion](configure-online-deletion.html) + - [Configure Advisory Deletion](configure-advisory-deletion.html) + - [Configure History Sharding](configure-history-sharding.html) + - [Configure Full History](configure-full-history.html) +- **References:** + - [ledger method][] + - [server_info method][] + - [ledger_request method][] + - [can_delete method][] + - [ledger_cleaner method][] diff --git a/content/concepts/the-rippled-server/peer-protocol.md b/content/concepts/the-rippled-server/peer-protocol.md index 8f151444de..c915cccb0d 100644 --- a/content/concepts/the-rippled-server/peer-protocol.md +++ b/content/concepts/the-rippled-server/peer-protocol.md @@ -69,6 +69,20 @@ Example configuration: ``` +## See Also + +- **Concepts:** + - [Consensus](consensus.html) + - [Parallel Networks](parallel-networks.html) +- **Tutorials:** + - [Configure the Peer Crawler](configure-the-peer-crawler.html) +- **References:** + - [peers method][] + - [connect method][] + - [fetch_info method][] + - [Peer Crawler](peer-crawler.html) + + {% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} diff --git a/content/concepts/the-rippled-server/rippled-server-modes.md b/content/concepts/the-rippled-server/rippled-server-modes.md index b9865f92a3..687caba2b7 100644 --- a/content/concepts/the-rippled-server/rippled-server-modes.md +++ b/content/concepts/the-rippled-server/rippled-server-modes.md @@ -60,8 +60,23 @@ When you run `rippled` in stand-alone mode, you have to tell it what ledger vers **Caution:** In stand-alone mode, you must [manually advance the ledger](advance-the-ledger-in-stand-alone-mode.html). + ## See Also -- [Commandline Usage Reference](commandline-usage.html) - Detailed information on command-line options for all `rippled` server modes. +- **References:** + - [Commandline Usage Reference](commandline-usage.html) - Detailed information on command-line options for all `rippled` server modes. + - [ledger_accept method][] - Manually advance the ledger in stand-alone mode. + - [feature method][] - Check [amendments](amendments.html) currently known and enabled. +- **Tutorials:** + - [Configure `rippled`](configure-rippled.html) + - [Run `rippled` as a Validator](run-rippled-as-a-validator.html) + - [Use rippled in Stand-Alone Mode](use-stand-alone-mode.html): + - [Start a New Genesis Ledger in Stand-Alone Mode](start-a-new-genesis-ledger-in-standalone-mode.html) + - [Load a Saved Ledger in Stand-Alone Mode](load-a-saved-ledger-in-standalone-mode.html) + - [Advance the Ledger in Stand-Alone Mode](advance-the-ledger-in-standalone-mode.html) + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} {% include '_snippets/rippled_versions.md' %} diff --git a/content/concepts/the-rippled-server/transaction-censorship-detection.md b/content/concepts/the-rippled-server/transaction-censorship-detection.md index 1431dcf6f2..49ac7dd4d3 100644 --- a/content/concepts/the-rippled-server/transaction-censorship-detection.md +++ b/content/concepts/the-rippled-server/transaction-censorship-detection.md @@ -57,5 +57,16 @@ Here are some scenarios that could cause the detector to issue false positive me Currently, there are no known bugs that cause this unexpected behavior. However, if you see the impact of what you suspect is a bug, consider reporting it to the [Ripple Bug Bounty](https://ripple.com/bug-bounty/) program. +## See Also + +- **Concepts:** + - [Consensus Principles and Rules](consensus-principles-and-rules.html) + - [Transaction Queue](transaction-queue.html) +- **Tutorials:** + - [Reliable Transaction Submission](reliable-transaction-submission.html) + - [Understanding Log Messages](understanding-log-messages.html) +- **References:** + - [Transaction Results](transaction-results.html) + {% include '_snippets/rippled_versions.md' %}