From b3bab06288766e89ed380dc5d4290d931b0d6cd6 Mon Sep 17 00:00:00 2001 From: ddawson Date: Mon, 12 Dec 2022 08:59:09 -0800 Subject: [PATCH] Moving use cases --- .../invariant-checking.md | 7 + .../transaction-queue.md | 2 +- .../become-an-xrp-ledger-gateway.md | 0 .../list-xrp-as-an-exchange.ja.md | 0 .../list-xrp-as-an-exchange.md | 0 .../list-your-exchange-on-xrp-charts.ja.md | 0 .../list-your-exchange-on-xrp-charts.md | 0 dactyl-config.yml | 212 +++++++++++------- 8 files changed, 138 insertions(+), 83 deletions(-) rename content/concepts/{server => transactions}/invariant-checking.md (97%) rename content/concepts/{server => transactions}/transaction-queue.md (99%) rename content/{tutorials => use-cases}/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md (100%) rename content/{tutorials => use-cases}/xrp-ledger-businesses/list-xrp-as-an-exchange.ja.md (100%) rename content/{tutorials => use-cases}/xrp-ledger-businesses/list-xrp-as-an-exchange.md (100%) rename content/{tutorials => use-cases}/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.ja.md (100%) rename content/{tutorials => use-cases}/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.md (100%) diff --git a/content/concepts/server/invariant-checking.md b/content/concepts/transactions/invariant-checking.md similarity index 97% rename from content/concepts/server/invariant-checking.md rename to content/concepts/transactions/invariant-checking.md index d5b4d18967..52cca26cb0 100644 --- a/content/concepts/server/invariant-checking.md +++ b/content/concepts/transactions/invariant-checking.md @@ -1,3 +1,10 @@ +--- +html: invariant-checking.html +parent: transactions.html +blurb: A safety feature that guarantees that certain invariants hold true across all transactions +labels: + - Transactions +--- # Invariant Checking Invariant checking is a safety feature of the XRP Ledger. It consists of a set of checks, separate from normal transaction processing, that guarantee that certain _invariants_ hold true across all transactions. diff --git a/content/concepts/server/transaction-queue.md b/content/concepts/transactions/transaction-queue.md similarity index 99% rename from content/concepts/server/transaction-queue.md rename to content/concepts/transactions/transaction-queue.md index 212ba853b5..604b7f7849 100644 --- a/content/concepts/server/transaction-queue.md +++ b/content/concepts/transactions/transaction-queue.md @@ -1,6 +1,6 @@ --- html: transaction-queue.html -parent: xrpl-servers.html +parent: transactions.html blurb: Set up an environment where you can submit transactions securely. labels: - Security diff --git a/content/tutorials/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md b/content/use-cases/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md similarity index 100% rename from content/tutorials/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md rename to content/use-cases/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md diff --git a/content/tutorials/xrp-ledger-businesses/list-xrp-as-an-exchange.ja.md b/content/use-cases/xrp-ledger-businesses/list-xrp-as-an-exchange.ja.md similarity index 100% rename from content/tutorials/xrp-ledger-businesses/list-xrp-as-an-exchange.ja.md rename to content/use-cases/xrp-ledger-businesses/list-xrp-as-an-exchange.ja.md diff --git a/content/tutorials/xrp-ledger-businesses/list-xrp-as-an-exchange.md b/content/use-cases/xrp-ledger-businesses/list-xrp-as-an-exchange.md similarity index 100% rename from content/tutorials/xrp-ledger-businesses/list-xrp-as-an-exchange.md rename to content/use-cases/xrp-ledger-businesses/list-xrp-as-an-exchange.md diff --git a/content/tutorials/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.ja.md b/content/use-cases/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.ja.md similarity index 100% rename from content/tutorials/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.ja.md rename to content/use-cases/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.ja.md diff --git a/content/tutorials/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.md b/content/use-cases/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.md similarity index 100% rename from content/tutorials/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.md rename to content/use-cases/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.md diff --git a/dactyl-config.yml b/dactyl-config.yml index 18b513fce3..79a44139b6 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -457,18 +457,6 @@ pages: targets: - en - ja - - - md: concepts/server/transaction-queue.md - parent: xrpl-servers.html - targets: - - en - - ja - - - md: concepts/server/invariant-checking.md - parent: xrpl-servers.html - targets: - - en - - md: concepts/xrpl/ledgers.md parent: concepts.html @@ -560,6 +548,12 @@ pages: - en - ja + - md: concepts/transactions/transaction-queue.md + parent: transactions.html + targets: + - en + - ja + - md: concepts/transactions/transaction-metadata-concept.md parent: transactions.html targets: @@ -571,6 +565,11 @@ pages: targets: - en - ja + + - md: concepts/transactions/invariant-checking.md + parent: transactions.html + targets: + - en - md: concepts/transactions/paths.md parent: transactions.html @@ -849,6 +848,43 @@ pages: - en - ja +# Use Cases -------------------------------------------------------------------- + + - name: Use Cases + html: use-cases.html + parent: docs.html + top_nav_grouping: Article Types + template: pagetype-category.html.jinja + blurb: Browse the documentation based on practical use cases. + targets: + - en + + # TODO: translate + - md: use-cases/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md + parent: use-cases.html + targets: + - en + - ja + + - md: use-cases/xrp-ledger-businesses/list-xrp-as-an-exchange.md + parent: use-cases.html + targets: + - en + + - md: use-cases/xrp-ledger-businesses/list-xrp-as-an-exchange.ja.md + parent: use-cases.html + targets: + - ja + + - md: use-cases/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.md + parent: use-cases.html + targets: + - en + + - md: use-cases/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.ja.md + parent: use-cases.html + targets: + - ja # Tutorials -------------------------------------------------------------------- @@ -1356,42 +1392,42 @@ pages: # TODO: Set up issuing/operational addresses, monitor changes to balances, # enable/disable rippling, use auth'd trust lines - - name: XRP Ledger Businesses - html: xrp-ledger-businesses.html - parent: tutorials.html - blurb: This section demonstrates how to follow various best practices for running businesses that interface with the XRP Ledger, such as exchanges listing XRP and gateways issuing currency in the XRP Ledger. - template: pagetype-category.html.jinja - targets: - - en - - - name: XRP Ledgerが利用する会社について - html: xrp-ledger-businesses.html - parent: tutorials.html - blurb: このセクションでは、さまざまなベストプラクティスに従って、XRPを上場する取引所やXRP Ledgerで通貨を発行するゲートウェアなど、XRP Ledgerとインターフェイス接続するビジネスを運営する方法をデモンストレーションします。 - template: pagetype-category.html.jinja - targets: - - ja - - - md: tutorials/xrp-ledger-businesses/list-xrp-as-an-exchange.md - targets: - - en - - - md: tutorials/xrp-ledger-businesses/list-xrp-as-an-exchange.ja.md - targets: - - ja - - - md: tutorials/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.md - targets: - - en - - - md: tutorials/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.ja.md - targets: - - ja - - - md: tutorials/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md - targets: - - en - - ja +# - name: XRP Ledger Businesses +# html: xrp-ledger-businesses.html +# parent: tutorials.html +# blurb: This section demonstrates how to follow various best practices for running businesses that interface with the XRP Ledger, such as exchanges listing XRP and gateways issuing currency in the XRP Ledger. +# template: pagetype-category.html.jinja +# targets: +# - en +# +# - name: XRP Ledgerが利用する会社について +# html: xrp-ledger-businesses.html +# parent: tutorials.html +# blurb: このセクションでは、さまざまなベストプラクティスに従って、XRPを上場する取引所やXRP Ledgerで通貨を発行するゲートウェアなど、XRP Ledgerとインターフェイス接続するビジネスを運営する方法をデモンストレーションします。 +# template: pagetype-category.html.jinja +# targets: +# - ja +# +# - md: tutorials/xrp-ledger-businesses/list-xrp-as-an-exchange.md +# targets: +# - en +# +# - md: tutorials/xrp-ledger-businesses/list-xrp-as-an-exchange.ja.md +# targets: +# - ja +# +# - md: tutorials/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.md +# targets: +# - en +# +# - md: tutorials/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.ja.md +# targets: +# - ja +# +# - md: tutorials/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md +# targets: +# - en +# - ja - name: Manage the rippled Server html: manage-the-rippled-server.html @@ -1866,25 +1902,6 @@ pages: targets: - en - ja - - - md: amendments/amendments.md - targets: - - en - - - md: amendments/known-amendments.md - parent: amendments.html - targets: - - en - - - md: amendments/amendments.ja.md - targets: - - ja - - - md: amendments/known-amendments.ja.md - parent: known-amendments.ja.html - targets: - - ja - # References ------------------------------------------------------------------- @@ -3824,26 +3841,57 @@ pages: targets: - ja +# Amendments ------------------------------------------------------------------- + + - name: Amendments + template: page-references.html.jinja + html: amendment-heading.html + parent: docs.html + top_nav_grouping: Article Types + sidebar: disabled + blurb: Complete references for different interfaces to the XRP Ledger. + targets: + - en + + - md: amendments/amendments.md + parent: amendment-heading.html + targets: + - en + + - md: amendments/known-amendments.md + parent: amendment-heading.html + targets: + - en + + - md: amendments/amendment-heading.ja.md + targets: + - ja + + - md: amendments/known-amendments.ja.md + parent: known-amendment-heading.ja.html + targets: + - ja + # --------------- end "Docs" section ------------------------------------------- # Use Cases: these have been removed. Only redirects remain. - - name: Use Cases - html: use-cases.html - template: pagetype-redirect.html.jinja - nav_omit: true - redirect_url: uses.html - targets: - - en - - - name: ユースケース - html: use-cases.html - template: pagetype-redirect.html.jinja - nav_omit: true - redirect_url: uses.html - targets: - - ja +# - name: Use Cases +# html: use-cases.html +# template: pagetype-redirect.html.jinja +# nav_omit: true +# redirect_url: uses.html +# targets: +# - en +# +# - name: ユースケース +# html: use-cases.html +# template: pagetype-redirect.html.jinja +# nav_omit: true +# redirect_url: uses.html +# targets: +# - ja - name: Run a rippled Validator html: run-a-rippled-validator.html