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

Docs landing; or, MOAR EMOJI

Browse Source
This commit is contained in:
mDuo13
2018-04-18 18:42:32 -07:00
parent 954c43cb83
commit e9457b60ff
6 changed files with 382 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
5layers.yml
View File

@@ -44,6 +44,10 @@ targets:
# Override them with --vars to change which fork/branch to edit.
github_forkurl: https://github.com/ripple/ripple-dev-portal
github_branch: master
recently_updated:
- tutorial-reliable-transaction-submission.html
- tutorial-checks-send.html
- reference-amendments.html
pages:
@@ -53,10 +57,6 @@ pages:
template: template-landing-docs.html
html: landing-docs.html
sidebar: disabled
recently_updated:
- tutorial-reliable-transaction-submission.html
- tutorial-checks-send.html
- reference-amendments.html
doc_type_blurbs:
Concepts: Learn the "what" and "why" behind fundamental aspects of the XRP Ledger.
Tutorials: Get step-by-step guidance to perform common tasks with the XRP Ledger.
@@ -72,6 +72,22 @@ pages:
targets:
- local
- name: Understanding the XRP Ledger
funnel: Docs
doc_type: Concepts
category: Understanding the XRP Ledger
html: concept-xrp-ledger.html
template: template-landing-category.html
targets:
- local
- md: concept-xrp-ledger-intro.md
funnel: Docs
doc_type: Concepts
category: Understanding the XRP Ledger
targets:
- local
- name: Payment System
funnel: Docs
doc_type: Concepts
@@ -170,6 +186,22 @@ pages:
category: Send and Receive Money
targets:
- local
- name: Manage the rippled Server
funnel: Docs
doc_type: Tutorials
category: Manage the rippled Server
template: template-landing-category.html
targets:
- local
- md: tutorial-rippled-setup.md
funnel: Docs
doc_type: Tutorials
category: Manage the rippled Server
targets:
- local
- name: References
funnel: Docs
doc_type: References
@@ -274,12 +306,17 @@ pages:
targets:
- local
- name: Test Empty Category
- md: reference-transaction-format.md
funnel: Docs
doc_type: References
category: Test Empty Category
html: reference-rippled-conventions.html
template: template-landing-category.html
category: Transaction Format
targets:
- local
- md: reference-data-api.md
funnel: Docs
doc_type: References
category: Data API
targets:
- local
@@ -290,6 +327,11 @@ pages:
targets:
- local
- md: tutorial-listing-xrp.md # TODO: split up and rename?
funnel: Use Cases
targets:
- local
- name: Dev Tools
funnel: Dev Tools
html: dev-tools.html

72
assets/css/devportal.css
View File

@@ -650,33 +650,6 @@ th {
line-height: 16px;
}
.portal-index ul {
border-top-left-radius: 5px;
border-top-right-radius: 5px;
padding: 0;
}
.portal-index li {
list-style: outside none none;
padding: 5px;
padding-left: 25px;
text-indent: 20px;
}
.portal-index li.top {
text-indent: 0;
}
.portal-index .dev_heading {
text-transform: uppercase;
text-decoration: none;
color: #202020;
}
.portal-index a.dev_heading:hover {
color: #27a2db;
text-decoration: underline;
}
.build-disclaimer {
font-size: 10pt;
margin: 2em 0;
@@ -684,14 +657,6 @@ th {
border-top: 1px solid #777;
}
.related-projects {
position: absolute;
top: 70px;
right: 15px;
width: 375px;
border: 1px solid #777;
border-radius: 5px;
}
.related-projects a {
text-decoration: none;
}
@@ -701,7 +666,6 @@ th {
.related-projects h3 {
margin: 0;
padding: 5px 15px;
border-bottom: 1px dashed #777;
}
.related-projects .project-name {
font-size: 18px;
@@ -937,17 +901,19 @@ th {
cursor: default;
}
.landing-docs .panel-title > a {
.landing .panel-title {
font-weight: bold;
}
.landing .panel-title > a {
text-decoration: none;
}
.landing-docs .curated-links li:first-child {
.landing .curated-links li:first-child {
margin-top: 5px;
}
.landing-docs .blurb p {
padding: 20px 0;
.landing .blurb {
padding: 20px;
}
.content p,
@@ -955,3 +921,29 @@ th {
.content td {
line-height: 1.65;
}
.readmore {
display: block;
margin: 15px auto 5px;
}
.readmore .btn {
font-size: 18px;
transition: 0.5s;
}
.hero-emoji {
font-size: 80px;
text-align: center;
}
.landing section {
padding: 40px 20px;
border-top: 1px solid #aaa;
}
.landing section:first-child {
padding-top: 0;
border-top-width: 0;
}

11
assets/css/ripple.css
View File

@@ -700,7 +700,6 @@ samp {
code {
padding: 2px 4px;
font-size: 90%;
color: #c7254e;
background-color: #f9f2f4;
border-radius: 4px;
}
@@ -2082,10 +2081,8 @@ select[multiple].input-lg {
background-image: none;
border: 1px solid transparent;
white-space: nowrap;
padding: 6px 12px;
font-size: 14px;
line-height: 1.42857143;
border-radius: 4px;
padding: 10px 15px;
border-radius: 5px;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
@@ -2164,7 +2161,6 @@ fieldset[disabled] .btn-default.active {
.btn-primary {
color: #ffffff;
background-color: #27a2db;
border-color: #2e5e96;
}
.btn-primary:hover,
.btn-primary:focus,
@@ -2172,8 +2168,7 @@ fieldset[disabled] .btn-default.active {
.btn-primary.active,
.open > .dropdown-toggle.btn-primary {
color: #ffffff;
background-color: #285282;
border-color: #204067;
background-color: #0987d7;
}
.btn-primary:active,
.btn-primary.active,

314
tool/template-5layerindex.html
View File

@@ -10,40 +10,302 @@
{% endblock %}
{% block bodyclasses %}xrp-ledger-dev-portal no-sidebar{% endblock %}
{% block bodyclasses %}landing no-sidebar{% endblock %}
{% block breadcrumbs %}{% endblock %}
{% block main %}
<div class="container portal-index">
<h2>All Pages</h2>
<section class="container">
<h1>Learn. Experiment. Integrate. Contribute.</h1>
<div class="row">
<div class="col-md-8">
<ul>
{% for page in pages %}
<li><a href="{{ page.html }}">{{ page.name }}</a></li>
{% endfor %}
<div class="blurb col-sm-12">
<p>The <a href="#xrp_ledger_intro">XRP Ledger</a> is built on <code>rippled</code>, an open-source technology that anyone can use. Use the tools and information provided here to integrate with and contribute to the open-source platform.</p>
</div>
</div>
</div>
<aside class="related-projects">
<h3>Related Projects</h3>
<div class="project">
<p><a class="client-portal-link" href="https://clients.ripple.com/" target="_blank">
<img class="project-icon" src="assets/img/RippleNet-condensed.svg" />
<span class="project-name">Ripple Client Portal</span>
<span class="login-required">(login required)</span>
</a></p>
<p class="project-summary">For financial institutions using Ripple's proprietary solutions to send money globally.</p>
</div>
<div class="project">
<p><a class="interledger-link" href="https://interledger.org/" target="_blank">
<img class="project-icon" src="assets/img/ilp_logo.svg" />
<span class="project-name">Interledger</span>
</a></p>
<p class="project-summary">An open protocol suite for connecting all forms of digital money.</p>
</aside>
<div class="row">
<div class="col-md-4">
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title"><a href="landing-references.html">Take Me to the References</a></h3>
</div><!--/.panel-heading-->
<div class="panel-body">
<div class="curated-links">
<ul>
<li><a href="reference-rippled-public.html"><code>rippled</code> Public API Methods</a></li>
<li><a href="reference-transaction-format.html"><code>rippled</code> Transaction Format</a></li> <!--{# TODO: Change this out when the transaction format gets split up #}-->
<li><a href="reference-data-api.html">Data API</a></li>
</ul>
</div><!--/.curated-links-->
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
<div class="col-sm-4">
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title">Get Started</h3>
</div><!--/.panel-heading-->
<div class="panel-body">
<div class="curated-links">
<ul>
<li><a href="websocket-api-tool.html">Make a call to the rippled API</a></li>
<li><a href="xrp-test-net-faucet.html">Access the XRP Ledger Test Net</a></li>
<li><a href="landing-concepts.html">Understand XRP Ledger Concepts</a></li>
</ul>
</div><!--/.curated-links-->
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
<div class="col-sm-4">
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title"><a href="tutorial-listing-xrp.html">List XRP in Your Exchange</a></h3>
</div><!--/.panel-heading-->
<div class="panel-body">
<p>Does your exchange want to list XRP?</p>
<div class="readmore">
<a href="tutorial-listing-xrp.html"><button class="btn btn-primary" type="button">Get Started</button></a>
</div>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
</div><!--/.row-->
<div class="row">
<div class="col-sm-4">
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title"><a href="tutorial-rippled-setup.html">Run <code>rippled</code></a></h3>
</div><!--/.panel-heading-->
<div class="panel-body">
<p><code>rippled</code> is the core server of the XRP Ledger. Anyone can run one.</p>
<div class="readmore">
<a href="tutorial-rippled-setup.html"><button class="btn btn-primary" type="button">Get Started</button></a>
</div>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
<div class="col-sm-4">
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title"><a href="https://github.com/ripple/rippled/">Contribute to <code>rippled</code><i class="fa fa-external-link"></i></a></h3>
</div><!--/.panel-heading-->
<div class="panel-body">
<p>Contribute code and bug reports to help improve <code>rippled</code>.</p>
<div class="readmore">
<a href="tutorial-rippled-setup.html"><button class="btn btn-primary" type="button">Get Started <i class="fa fa-external-link"></i></button></a>
</div>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
<div class="col-sm-4">
<div class="panel panel-default">
<div class="panel-heading">
<!--{# TODO: replace this with "Provide Liquidity" use case link when we have it #}-->
<h3 class="panel-title"><a href="tutorial-gateway-guide.html">Issue Currency in the XRP Ledger</a></h3>
</div><!--/.panel-heading-->
<div class="panel-body">
<p>Are you a potential gateway who wants to issue currency in the XRP Ledger?</p>
<div class="readmore">
<a href="tutorial-gateway-guide.html"><button class="btn btn-primary" type="button">Get Started</button></a>
</div>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
</div><!--/.row-->
</section>
<section class="container odd">
<div class="row">
<div class="col-sm-6">
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title">New and Updated Documentation</h3>
</div><!--/.panel-heading-->
<div class="panel-body">
<div class="curated-links">
<ol>
{% for link in target.recently_updated %}
{% set linkpage = pages|selectattr("html", "equalto", link)|first %}
<li><a href="{{linkpage.html}}">{{linkpage.name}}</a></li>
{% endfor %}
</ol>
</div><!--/.curated-links-->
</div><!--/.panel-body-->
</div><!--/.panel-->
</div>
<div class="col-sm-6">
<div class="panel panel-default">
<div class="panel-heading">
<h3 class="panel-title"><a href="reference-amendments.html">Known Amendments</a></h3>
</div><!--/.panel-heading-->
<div class="panel-body">
<p>Amendments introduce new features to the decentralized XRP Ledger without causing disruptions.</p>
<div class="readmore">
<a href="reference-amendments.html"><button class="btn btn-primary" type="button">View Known Amendments</button></a>
</div>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
</div><!--/.row-->
</section>
<section class="container" id="#xrp_ledger_intro">
<h2><a href="concept-xrp-ledger-intro.html">XRP Ledger: A decentralized cryptographic ledger</a></h2>
<div class="row">
<div class="blurb col-sm-12">
<p>The XRP Ledger is built powered by a network of peer-to-peer servers. It is the home of XRP, a digital asset designed to bridge the many different currencies in use worldwide.</p>
<p>Ripple stewards the development of the XRP Ledger, and advances XRP as a key contribution to the Internet of Value: a wordl in which money moves the way information does today.</p>
</div>
</div>
<div class="row">
<div class="col-sm-6">
<div class="panel panel-default">
<div class="panel-body">
<p class="hero-emoji">💯</p>
<h3><a href="concept-xrp-ledger-intro.html#the-best-digital-asset">The Best Digital Asset</a></h3>
<p>XRP is a digital asset native to the XRP Ledger. Anyone with a cryptographic key and an internet connection can receive, hold, and send XRP to anyone else.</p>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
<div class="col-sm-6">
<div class="panel panel-default">
<div class="panel-body">
<p class="hero-emoji">🙉</p>
<h3><a href="concept-xrp-ledger-intro.html#censorship-resistant-transaction-processing">Censorship-Resistant Transaction Processing</a></h3>
<p>No single party decides which XRP transactions succeed or fail, and no one can "roll back" a transaction after it completes.</p>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
</div><!--/.row-->
<div class="row">
<div class="col-sm-6">
<div class="panel panel-default">
<div class="panel-body">
<p class="hero-emoji">💨</p>
<h3><a href="concept-xrp-ledger-intro.html#fast-efficient-consensus-algorithm">Fast, Efficient Consensus Algorithm</a></h3>
<p>The XRP Ledger's consensus algorithm settles transactions in 4 to 5 seconds, processing at a throughput of up to 1500 transactions per second.</p>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
<div class="col-sm-6">
<div class="panel panel-default">
<div class="panel-body">
<p class="hero-emoji">📈</p>
<h3><a href="concept-xrp-ledger-intro.html#finite-xrp-supply">Finite XRP Supply</a></h3>
<p>When the XRP Ledger began, 100 billion XRP were created, and no more XRP will ever be created.</p>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
</div><!--/.row-->
<div class="row">
<div class="col-sm-6">
<div class="panel panel-default">
<div class="panel-body">
<p class="hero-emoji">⚖️</p>
<h3><a href="concept-xrp-ledger-intro.html#responsible-software-governance">Responsible Software Governance</a></h3>
<p>A team of full-time, world-class developers at Ripple maintain and continually improve the XRP Ledger's underlying software.</p>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
<div class="col-sm-6">
<div class="panel panel-default">
<div class="panel-body">
<p class="hero-emoji">🔐</p>
<h3><a href="concept-xrp-ledger-intro.html#secure-adaptable-cryptography">Secure, Adaptable Cryptography</a></h3>
<p>The XRP Ledger relies on industry standard digital signature systems like ECDSA and also supports modern, efficient algorithms like Ed25519.</p>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
</div><!--/.row-->
<div class="row">
<div class="col-sm-6">
<div class="panel panel-default">
<div class="panel-body">
<p class="hero-emoji">⚙️</p>
<h3><a href="concept-xrp-ledger-intro.html#modern-features-for-smart-contracts">Modern Features for Smart Contracts</a></h3>
<p>Features like Escrow, Checks, and Payment Channels support cutting-edge financial applications while safety features like Invariant Checks and Amendments provide for stable operation.</p>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
<div class="col-sm-6">
<div class="panel panel-default">
<div class="panel-body">
<p class="hero-emoji">💱</p>
<h3><a href="concept-xrp-ledger-intro.html#modern-features-for-smart-contracts">On-Ledger Decentralized Exchange</a></h3>
<p>The XRP Ledger also has a fully-functional accounting system for tracking and trading obligations denominated in any way users want, and an exchange built into the protocol.</p>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
</div><!--/.row-->
</section>
<section class="container related-projects odd">
<h2>Related Projects</h2>
<div class="col-sm-6">
<div class="panel panel-default">
<div class="panel-body">
<p><a class="client-portal-link" href="https://clients.ripple.com/" target="_blank">
<img class="project-icon" src="assets/img/RippleNet-condensed.svg" />
<span class="project-name">Ripple Client Portal</span>
<span class="login-required">(login required)</span>
</a></p>
<p class="project-summary">For financial institutions using Ripple's proprietary solutions to send money globally.</p>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
<div class="col-sm-6">
<div class="panel panel-default">
<div class="panel-body">
<p><a class="interledger-link" href="https://interledger.org/" target="_blank">
<img class="project-icon" src="assets/img/ilp_logo.svg" />
<span class="project-name">Interledger</span>
</a></p>
<p class="project-summary">An open protocol suite for connecting all forms of digital money.</p>
</div><!--/.panel-body-->
</div><!--/.panel-->
</div><!--/.col-->
</section>
<section class="container portal-index">
<h2>Full Sitemap (development purposes)</h2>
<div class="row">
<div class="col-md-8">
{% include 'template-page-children.html' %}
</div>
</div>
</section>
<!-- Disclaimer block -->
<div class="container build-disclaimer">

4
tool/template-landing-docs.html
View File

@@ -3,7 +3,7 @@
{% block sidebar %}
{% endblock %}
{% block bodyclasses %}landing-docs {% endblock %}
{% block bodyclasses %}landing{% endblock %}
{% block main %}
<section class="container">
@@ -105,7 +105,7 @@
<div class="panel-body">
<div class="curated-links">
<ol>
{% for link in currentpage.recently_updated %}
{% for link in target.recently_updated %}
{% set linkpage = pages|selectattr("html", "equalto", link)|first %}
<li><a href="{{linkpage.html}}">{{linkpage.name}}</a></li>
{% endfor %}

9
tool/template-page-children.html
View File

@@ -6,7 +6,10 @@
{% endif %}
{% if parent_page.funnel is undefined %}
<!-- TEMPLATE ERROR: need funnel for children-display -->
{% set parent_level = "home" %}
{% set level_2 = "funnel" %}
{% set level_3 = "doc_type" %}
{% set childpages = pages %}{# special case for home #}
{% elif parent_page == pages|selectattr("funnel", "equalto", parent_page.funnel)|first %}
{% set parent_level = "funnel" %}
{% set level_2 = "doc_type" %}
@@ -27,7 +30,9 @@
<!-- TEMPLATE ERROR: page {{parent_page.name}} is not the parent of anything? -->
{% endif %}
<!-- parent_level is {{parent_level}} -->
{% set childpages = pages|selectattr(parent_level, "equalto", parent_page[parent_level])|list %}
{% if parent_level != "home" %}
{% set childpages = pages|selectattr(parent_level, "equalto", parent_page[parent_level])|list %}
{% endif %}
<div class="children-display">
<ul>