213 lines
23 KiB
HTML
213 lines
23 KiB
HTML
|
<!doctype html>
|
|||
|
|
<html itemscope itemtype="http://schema.org/WebPage" lang="en" class="no-js">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
|
|||
|
|
<meta name="generator" content="Hugo 0.92.2" />
|
|||
|
|
<link rel="canonical" type="text/html" href="/docs/concepts/">
|
|||
|
|
<link rel="alternate" type="application/rss+xml" href="/docs/concepts/index.xml">
|
|||
|
|
<meta name="robots" content="noindex, nofollow">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="/favicons/favicon.ico" >
|
|||
|
|
<link rel="apple-touch-icon" href="/favicons/apple-touch-icon-180x180.png" sizes="180x180">
|
|||
|
|
<link rel="icon" type="image/png" href="/favicons/favicon-16x16.png" sizes="16x16">
|
|||
|
|
<link rel="icon" type="image/png" href="/favicons/favicon-32x32.png" sizes="32x32">
|
|||
|
|
<link rel="icon" type="image/png" href="/favicons/android-36x36.png" sizes="36x36">
|
|||
|
|
<link rel="icon" type="image/png" href="/favicons/android-48x48.png" sizes="48x48">
|
|||
|
|
<link rel="icon" type="image/png" href="/favicons/android-72x72.png" sizes="72x72">
|
|||
|
|
<link rel="icon" type="image/png" href="/favicons/android-96x96.png" sizes="96x96">
|
|||
|
|
<link rel="icon" type="image/png" href="/favicons/android-144x144.png" sizes="144x144">
|
|||
|
|
<link rel="icon" type="image/png" href="/favicons/android-192x192.png" sizes="192x192">
|
|||
|
|
|
|||
|
|
<title>Concepts | Federated Docs</title>
|
|||
|
|
<meta name="description" content="What does your user need to understand about your project in order to use it - or potentially contribute to it?
|
|||
|
|
">
|
|||
|
|
<meta property="og:title" content="Concepts" />
|
|||
|
|
<meta property="og:description" content="What does your user need to understand about your project in order to use it - or potentially contribute to it?
|
|||
|
|
" />
|
|||
|
|
<meta property="og:type" content="website" />
|
|||
|
|
<meta property="og:url" content="/docs/concepts/" />
|
|||
|
|
|
|||
|
|
<meta itemprop="name" content="Concepts">
|
|||
|
|
<meta itemprop="description" content="What does your user need to understand about your project in order to use it - or potentially contribute to it?
|
|||
|
|
"><meta name="twitter:card" content="summary"/>
|
|||
|
|
<meta name="twitter:title" content="Concepts"/>
|
|||
|
|
<meta name="twitter:description" content="What does your user need to understand about your project in order to use it - or potentially contribute to it?
|
|||
|
|
"/>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="preload" href="/scss/main.min.43ad6541a45f31cd03dd1066a29ba2595ef582b492c6241a2288367893840e77.css" as="style">
|
|||
|
|
<link href="/scss/main.min.43ad6541a45f31cd03dd1066a29ba2595ef582b492c6241a2288367893840e77.css" rel="stylesheet" integrity="">
|
|||
|
|
|
|||
|
|
<script
|
|||
|
|
src="https://code.jquery.com/jquery-3.6.0.min.js"
|
|||
|
|
integrity="sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK"
|
|||
|
|
crossorigin="anonymous"></script>
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="td-section">
|
|||
|
|
<header>
|
|||
|
|
<nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar">
|
|||
|
|
<a class="navbar-brand" href="/"><span class="navbar-brand__logo navbar-logo"><svg id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 500 500" style="enable-background:new 0 0 500 500"><g><path style="fill:#fff" d="M116.8525 421.9722c-5.7041.0-10.3442-4.3127-10.3442-9.6129V88.183c0-5.3002 4.6401-9.6117 10.3442-9.6117H320.858c3.0347.0 9.3959.5498 11.7506 2.6302l.3545.3442 58.905 63.2912c2.3101 2.491 2.9202 8.4928 2.9202 11.3184v256.2039c0 5.3002-4.6407 9.6129-10.3436 9.6129H116.8525z"/><g><g><g><path style="fill:#767676" d="M384.4445 423.2066H116.852c-6.3839.0-11.5786-4.8658-11.5786-10.8474V88.1831c0-5.9804 5.1947-10.8461 11.5786-10.8461h204.0062c.377.0 9.2786.0329 12.568 2.9389l.3947.3833 58.9508 63.337c3.2135 3.4652 3.2514 11.7924 3.2514 12.1593v256.2036C396.0231 418.3408 390.8284 423.2066 384.4445 423.2066zM116.5079 411.9189c.0848.0278.1999.0531.3441.0531h267.5925c.1442.0.2581-.0253.3441-.0531V156.1556c-.0076-.9033-.3593-3.7347-.7034-5.0037l-57.6527-61.9416c-1.4651-.3176-4.4533-.6389-5.5742-.6389H116.852c-.143.0-.2594.024-.3441.0531V411.9189zm267.4533-261.149zM327.0321 89.371v.0013V89.371z"/></g></g></g><g><g><path style="fill:#5b7fc0" d="M189.0874 210.1754l.0012-.0012c7.7751.0012 15.0295 4.1862 18.932 10.9234 1.9177 3.3159 2.9305 7.1011 2.9293 10.9378.0 5.8394-2.2733 11.3304-6.4032 15.4604-4.1288 4.1288-9.6186 6.4032-15.458 6.4032s-11.328-2.2733-15.458-6.4032-6.4032-9.6186-6.4056-15.4628c.0012-6.025 2.454-11.4897 6.4116-15.4473C177.5953 212.627 183.0601 210.1742 189.0874 210.1754zm7.993 21.8576c.0012-1.4042-.3687-2.7868-1.063-3.9887-1.4293-2.4684-4.0833-3.9995-6.9299-4.0019-4.4077.0024-7.993 3.5877-7.993 7.993.0 2.1356.832 4.1431 2.3427 5.6539 1.5083 1.5083 3.5159 2.3403 5.6503 2.3415 2.1356.0 4.1443-.8308 5.6539-2.3403S197.0816 234.1722 197.0804 232.033z"/><path style="opacity:.3;fill:#fff" d="M189.0898 210.176c7.7763.0 15.0283 4.1826 18.926 10.9151 1.9201 3.3136 2.9377 7.0988 2.9353 10.9462.0024 12.0643-9.8065 21.8636-21.8613 21.8613-12.0547.0024-21.8636-9.8066-21.8612-21.8613.0-6.0285 2.4516-11.4921 6.4116-15.452C177.5977 212.6276 183.0612 210.176 189.0898 210.176zm7.9941 21.8612c0-1.4078-.3711-2.7892-1.0702-3.9959-1.4269-2.466-4.0797-3.9983-6.924-3.9983-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0024 4.4077 3.5865 7.9918 7.9942 7.9942 2.2027.0 4.2018-.8978 5.6479-2.3439C196.1861 236.239 197.0839 234.2399 197.0839 232.0372z"/><g><defs><path id="SVGID_1_" d="M194.7376 237.6875c-1.4461 1.4461-3.4452 2.3439-5.6479 2.3439-4.4077-.0024-7.9918-3.5865-7.9942-7.9942.0024-4.4125 3.5937-7.999 7.9942-7.9942 2.8443.0 5.497 1.5323 6.924 3.9983.6991 1.2067 1.0702 2.5881 1.0702 3.9959C197.0839 234.2399 196.1861 236.239 194.7376 237.6875z"/></defs><clipPath id="SVGID_2_"><use xlink:href="#SVGID_1_" style="overflow:visible"/></clipPath><path style="clip-path:url(#SVGID_2_);fill:#fff" d="M190.0704 225.0237c-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0011 1.9546.7088 3.7452 1.8782 5.1354-1.7447-1.4674-2.8575-3.663-2.8588-6.116.0024-4.4125 3.5936-7.999 7.9942-7.9942 2.3802-1e-4 4.616 1.0833 6.1218 2.8788C193.7885 225.7247 191.9774 225.0237 190.0704 225.0237z"/><path style="opacity:.13;clip-path:url(#SVGID_2_);fill:#020202" d="M190.0704 225.0237c-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0011 1.9546.7088 3.7452 1.8782 5.1354-1.7447-1.4674-2.8575-3.663-2.8588-6.116.0024-4.4125 3.5936-7.999 7.9942-7.9942 2.3802-1e-4 4.616 1.0833 6.1218 2.8788C193.7885 225.7247 191.9774 225.0237 190.0704 225.0237z"/></g><g><defs><path id="SVGID_3_" d="M189.0898 210.176c7.7763.0 15.0283 4.1826 18.926 10.9151 1.9201 3.3136 2.9377 7.0988 2.9353 10.9462.0024 12.0643-9.8065 21.8636-21.8613 21.8613-12.0547.0024-21.8636-9.8066-21.8612-21.8613.0-6.0285 2.4516-11.4921 6.4116-15.452C177.5977 212.6276 183.0612 210.176 189.0898 210.176zm7.9941 21.8612c0-1.4078-.3711-2.7892-1.0702-3.9959-1.4269-2.466-4.0797-3.9983-6.924-3.9983-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0024 4.4077 3.5865 7.9918 7.9942 7.9942 2.2027.0 4.2018-.8978 5.6479-2.3439C196.1861 236.239 197.0839 234.2399 197.0839 232.0372z"/></defs><clipPath id="
|
|||
|
|
<div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
|
|||
|
|
<ul class="navbar-nav mt-2 mt-lg-0">
|
|||
|
|
<li class="nav-item mr-4 mb-2 mb-lg-0">
|
|||
|
|
<a class="nav-link" href="/about/"><span>About</span></a>
|
|||
|
|
</li>
|
|||
|
|
<li class="nav-item mr-4 mb-2 mb-lg-0">
|
|||
|
|
<a class="nav-link active" href="/docs/"><span class="active">Documentation</span></a>
|
|||
|
|
</li>
|
|||
|
|
<li class="nav-item mr-4 mb-2 mb-lg-0">
|
|||
|
|
<a class="nav-link" href="/blog/"><span>Blog</span></a>
|
|||
|
|
</li>
|
|||
|
|
<li class="nav-item mr-4 mb-2 mb-lg-0">
|
|||
|
|
<a class="nav-link" href="/community/"><span>Community</span></a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
<div class="navbar-nav d-none d-lg-block">
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
</header>
|
|||
|
|
<div class="container-fluid td-outer">
|
|||
|
|
<div class="td-main">
|
|||
|
|
<div class="row flex-xl-nowrap">
|
|||
|
|
<main class="col-12 col-md-9 col-xl-8 pl-md-5" role="main">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="td-content">
|
|||
|
|
<div class="pageinfo pageinfo-primary d-print-none">
|
|||
|
|
<p>
|
|||
|
|
This is the multi-page printable view of this section.
|
|||
|
|
<a href="#" onclick="print();return false;">Click here to print</a>.
|
|||
|
|
</p><p>
|
|||
|
|
<a href="/docs/concepts/">Return to the regular view of this page</a>.
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<h1 class="title">Concepts</h1>
|
|||
|
|
<div class="lead">What does your user need to understand about your project in order to use it - or potentially contribute to it?</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="content">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="pageinfo pageinfo-primary">
|
|||
|
|
<p>This is a placeholder page that shows you how to use this template site.</p>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<p>For many projects, users may not need much information beyond the information in the <a href="/docs/overview/">Overview</a>, so this section is <strong>optional</strong>. However if there are areas where your users will need a more detailed understanding of a given term or feature in order to do anything useful with your project (or to not make mistakes when using it) put that information in this section. For example, you may want to add some conceptual pages if you have a large project with many components and a complex architecture.</p>
|
|||
|
|
<p>Remember to focus on what the user needs to know, not just what you think is interesting about your project! If they don’t need to understand your original design decisions to use or contribute to the project, don’t put them in, or include your design docs in your repo and link to them. Similarly, most users will probably need to know more about how features work when in use rather than how they are implemented. Consider a separate architecture page for more detailed implementation and system design information that potential project contributors can consult.</p>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</main>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<footer class="bg-dark py-5 row d-print-none">
|
|||
|
|
<div class="container-fluid mx-sm-5">
|
|||
|
|
<div class="row">
|
|||
|
|
<div class="col-6 col-sm-4 text-xs-center order-sm-2">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<ul class="list-inline mb-0">
|
|||
|
|
|
|||
|
|
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="User mailing list" aria-label="User mailing list">
|
|||
|
|
<a class="text-white" target="_blank" rel="noopener" href="https://federated.computer/mail" aria-label="User mailing list">
|
|||
|
|
<i class="fa fa-envelope"></i>
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="Twitter" aria-label="Twitter">
|
|||
|
|
<a class="text-white" target="_blank" rel="noopener" href="https://twitter.com/federatedworld" aria-label="Twitter">
|
|||
|
|
<i class="fab fa-twitter"></i>
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="col-6 col-sm-4 text-right text-xs-center order-sm-3">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<ul class="list-inline mb-0">
|
|||
|
|
|
|||
|
|
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="GitHub" aria-label="GitHub">
|
|||
|
|
<a class="text-white" target="_blank" rel="noopener" href="https://github.com/federatedcomputer" aria-label="GitHub">
|
|||
|
|
<i class="fab fa-github"></i>
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="Developer mailing list" aria-label="Developer mailing list">
|
|||
|
|
<a class="text-white" target="_blank" rel="noopener" href="https://federated.computer/developers" aria-label="Developer mailing list">
|
|||
|
|
<i class="fa fa-envelope"></i>
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
|
|||
|
|
<small class="text-white">© 2023 Federated Computer, Inc. All Rights Reserved</small>
|
|||
|
|
<small class="ml-1"><a href="https://federated.computer" target="_blank" rel="noopener">Privacy Policy</a></small>
|
|||
|
|
|
|||
|
|
<p class="mt-2"><a href="/about/">About Federated Core</a></p>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<script src="/js/main.min.8741557c571337827a7eb4977ad59c86860ae95b8e86a17138d36f059fa5fe23.js" integrity="sha256-h0FVfFcTN4J6frSXetWchoYK6VuOhqFxONNvBZ+l/iM=" crossorigin="anonymous"></script>
|
|||
|
|
<script src='/js/tabpane-persist.js'></script>
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|