Skip to content

Commit

Permalink
Deployed ed8e5af with MkDocs version: 1.4.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Oct 9, 2023
1 parent dce8770 commit 7d4fe8e
Show file tree
Hide file tree
Showing 10 changed files with 69 additions and 53 deletions.
4 changes: 2 additions & 2 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@


<link rel="icon" href="/assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.11">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.13">



Expand Down Expand Up @@ -376,7 +376,7 @@ <h1>404 - Not found</h1>
<script id="__config" type="application/json">{"base": "/", "features": [], "search": "/assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="/assets/javascripts/bundle.fac441b0.min.js"></script>
<script src="/assets/javascripts/bundle.b4d07000.min.js"></script>


</body>
Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions cli/cli/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<link rel="next" href="../cli_cmnds_build/">

<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.11">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.13">



Expand Down Expand Up @@ -799,7 +799,7 @@ <h2 id="trunk-install"><code>trunk install</code><a class="headerlink" href="#tr
<script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
<script src="../../assets/javascripts/bundle.b4d07000.min.js"></script>


</body>
Expand Down
4 changes: 2 additions & 2 deletions cli/cli_cmnds_build/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<link rel="next" href="../../registry/registry/">

<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.11">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.13">



Expand Down Expand Up @@ -681,7 +681,7 @@ <h3 id="pgrx-based-extensions">PGRX Based Extensions<a class="headerlink" href="
<script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
<script src="../../assets/javascripts/bundle.b4d07000.min.js"></script>


</body>
Expand Down
86 changes: 51 additions & 35 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<link rel="next" href="cli/cli/">

<link rel="icon" href="assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.11">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.13">



Expand Down Expand Up @@ -252,19 +252,26 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#trunk-cli" class="md-nav__link">
Trunk CLI
</a>

<nav class="md-nav" aria-label="Trunk CLI">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
Installation
</a>

</li>

<li class="md-nav__item">
<a href="#trunk-cli" class="md-nav__link">
Trunk CLI
<li class="md-nav__item">
<a href="#usage" class="md-nav__link">
Usage
</a>

<nav class="md-nav" aria-label="Trunk CLI">
<ul class="md-nav__list">
</li>

<li class="md-nav__item">
<a href="#trunk-build" class="md-nav__link">
Expand Down Expand Up @@ -301,7 +308,7 @@

<li class="md-nav__item">
<a href="#contributing" class="md-nav__link">
Contributing
Contributing
</a>

</li>
Expand Down Expand Up @@ -435,19 +442,26 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#trunk-cli" class="md-nav__link">
Trunk CLI
</a>

<nav class="md-nav" aria-label="Trunk CLI">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
Installation
</a>

</li>

<li class="md-nav__item">
<a href="#trunk-cli" class="md-nav__link">
Trunk CLI
<li class="md-nav__item">
<a href="#usage" class="md-nav__link">
Usage
</a>

<nav class="md-nav" aria-label="Trunk CLI">
<ul class="md-nav__list">
</li>

<li class="md-nav__item">
<a href="#trunk-build" class="md-nav__link">
Expand Down Expand Up @@ -484,7 +498,7 @@

<li class="md-nav__item">
<a href="#contributing" class="md-nav__link">
Contributing
Contributing
</a>

</li>
Expand All @@ -510,21 +524,23 @@

<h1 id="trunk">Trunk<a class="headerlink" href="#trunk" title="Permanent link">&para;</a></h1>
<p><a href="https://crates.io/crates/pg-trunk"><img alt="version" src="https://img.shields.io/crates/v/pg-trunk?label=CLI&amp;logo=rust" /></a>
<a href="https://ossrank.com/p/2643"><img alt="OSSRank" src="https://shields.io/endpoint?url=https://ossrank.com/shield/2643" /></a></p>
<p>Trunk is an open source package manager and registry for Postgres extensions. Use the Trunk CLI to build, publish
and install Postgres extensions <em>of all kinds</em>.</p>
<img alt="" src="https://img.shields.io/badge/Ubuntu_22.x-180%20extensions-orange" />
<a href="https://ossrank.com/p/2643"><img alt="OSSRank" src="https://shields.io/endpoint?url=https://ossrank.com/shield/2643" /></a>
<a href="https://join.slack.com/t/trunk-community/shared_invite/zt-1yiafma92-hFHq2xAN0ukjg_2AsOVvfg"><img alt="Slack" src="https://img.shields.io/badge/%40trunk-community?logo=slack&amp;label=slack" /></a></p>
<p>Trunk is an open source package manager and registry for PostgreSQL (Postgres) extensions:
- Visit <a href="https://pgt.dev">pgt.dev</a> to discover and learn more about the building blocks of this rich ecosystem
- Use the Trunk CLI (<a href="https://crates.io/crates/pg-trunk">pg-trunk</a>) to build, publish and install Postgres extensions <em>of all kinds</em>.</p>
<p><img alt="trunk-install-larger-font" src="https://github.com/tembo-io/trunk/assets/8935584/1c09e899-c77a-48c1-a978-a46f03774f1a" /></p>
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h2>
<p>The Trunk CLI is hosted at crates.io and can be installed with cargo.
<h2 id="trunk-cli">Trunk CLI<a class="headerlink" href="#trunk-cli" title="Permanent link">&para;</a></h2>
<h3 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h3>
<p>To get started, run the following commands to download and leverage cargo to install Trunk's CLI.
1. <code>curl https://sh.rustup.rs -sSf | sh</code>
2. <code>cargo install pg-trunk</code></p>
<h2 id="trunk-cli">Trunk CLI<a class="headerlink" href="#trunk-cli" title="Permanent link">&para;</a></h2>
<h3 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h3>
<p>The Trunk CLI allows for building, publishing and installing Postgres extensions of all kinds. It abstracts away
complexities of extension development and management with the following commands:</p>
<h3 id="trunk-build"><code>trunk build</code><a class="headerlink" href="#trunk-build" title="Permanent link">&para;</a></h3>
<ul>
<li>Compile extensions of all kinds.</li>
</ul>
<p>Compile extensions of all kinds.</p>
<div class="codehilite"><pre><span></span><code><span class="w"> </span>trunk<span class="w"> </span>build
Building<span class="w"> </span>from<span class="w"> </span>path<span class="w"> </span>.
Detected<span class="w"> </span>that<span class="w"> </span>we<span class="w"> </span>are<span class="w"> </span>building<span class="w"> </span>a<span class="w"> </span>pgrx<span class="w"> </span>extension
Expand All @@ -544,9 +560,7 @@ <h3 id="trunk-build"><code>trunk build</code><a class="headerlink" href="#trunk-
</code></pre></div>

<h3 id="trunk-publish"><code>trunk publish</code><a class="headerlink" href="#trunk-publish" title="Permanent link">&para;</a></h3>
<ul>
<li>Publish extensions to the registry, making them available to the Postgres community for discovery and installation.</li>
</ul>
<p>Publish extensions to the registry, making them available to the Postgres community for discovery and installation.</p>
<div class="codehilite"><pre><span></span><code><span class="w"> </span>trunk<span class="w"> </span>publish<span class="w"> </span>pgmq<span class="w"> </span><span class="se">\</span>
--version<span class="w"> </span><span class="m">0</span>.5.0<span class="w"> </span><span class="se">\</span>
--description<span class="w"> </span><span class="s2">&quot;Message Queue for postgres&quot;</span><span class="w"> </span><span class="se">\</span>
Expand All @@ -557,10 +571,8 @@ <h3 id="trunk-publish"><code>trunk publish</code><a class="headerlink" href="#tr
</code></pre></div>

<h3 id="trunk-install"><code>trunk install</code><a class="headerlink" href="#trunk-install" title="Permanent link">&para;</a></h3>
<ul>
<li>Downloads Postgres extensions from the Trunk registry and installs in whichever environment trunk is run.</li>
<li>Supports nested dependencies, e.g. installing <code>extension_a</code> will automatically install <code>extension_b</code> if required.</li>
</ul>
<p>Downloads Postgres extensions from the Trunk registry and installs into your environment (only Ubuntu suppot at this time).</p>
<p>Supports nested dependencies, e.g. installing <code>extension_a</code> will automatically install <code>extension_b</code> if required.</p>
<div class="codehilite"><pre><span></span><code><span class="w"> </span>trunk<span class="w"> </span>install<span class="w"> </span>pgmq
Using<span class="w"> </span>pg_config:<span class="w"> </span>/usr/bin/pg_config
Using<span class="w"> </span>pkglibdir:<span class="w"> </span><span class="s2">&quot;/usr/lib/postgresql/15/lib&quot;</span>
Expand All @@ -574,7 +586,7 @@ <h3 id="trunk-install"><code>trunk install</code><a class="headerlink" href="#tr
</code></pre></div>

<h2 id="trunk-registry-httpspgtdev">Trunk Registry - https://pgt.dev<a class="headerlink" href="#trunk-registry-httpspgtdev" title="Permanent link">&para;</a></h2>
<p>The Trunk registry serves as the community's hub for Postgres extensions of all kinds. The Trunk CLI installs extensions and
<p>The Trunk registry serves as a community hub for Postgres extensions of all kinds. The Trunk CLI installs extensions and
their dependencies as compiled artifacts from this registry.</p>
<ul>
<li>Extension discovery and search</li>
Expand All @@ -583,14 +595,18 @@ <h2 id="trunk-registry-httpspgtdev">Trunk Registry - https://pgt.dev<a class="he
<li>Usage metrics to provide insight into popular and well-maintained extensions</li>
<li>Version tracking and new release email notifications</li>
</ul>
<h2 id="contributing">Contributing<a class="headerlink" href="#contributing" title="Permanent link">&para;</a></h2>
<h2 id="contributing">Contributing<a class="headerlink" href="#contributing" title="Permanent link">&para;</a></h2>
<p>Trunk is in active development, and we look forward to the contributions the Postgres community has to offer.
If you're interested in contributing, please open a pull request, issue, or reach out:</p>
If you're interested in contributing, please open a pull request, issue, or reach out!</p>
<ul>
<li><a href="https://join.slack.com/t/trunk-crew/shared_invite/zt-1yiafma92-hFHq2xAN0ukjg_2AsOVvfg">Slack</a></li>
<li><a href="https://twitter.com/tembo_io">Twitter</a></li>
<li>Email us at <a href="mailto:hello@tembo.io">hello@tembo.io</a></li>
</ul>
<p>Thanks goes to these incredible people:</p>
<p><a href="https://github.com/tembo-io/trunk/graphs/contributors">
<img src="https://contrib.rocks/image?repo=tembo-io/trunk" />
</a></p>



Expand Down Expand Up @@ -631,7 +647,7 @@ <h2 id="contributing">Contributing<a class="headerlink" href="#contributing" tit
<script id="__config" type="application/json">{"base": ".", "features": [], "search": "assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="assets/javascripts/bundle.fac441b0.min.js"></script>
<script src="assets/javascripts/bundle.b4d07000.min.js"></script>


</body>
Expand Down
4 changes: 2 additions & 2 deletions registry/registry/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<link rel="next" href="../../ui/ui/">

<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.11">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.13">



Expand Down Expand Up @@ -574,7 +574,7 @@ <h2 id="architecture">Architecture<a class="headerlink" href="#architecture" tit
<script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
<script src="../../assets/javascripts/bundle.b4d07000.min.js"></script>


</body>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.
4 changes: 2 additions & 2 deletions ui/ui/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@


<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.11">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.13">



Expand Down Expand Up @@ -497,7 +497,7 @@ <h2 id="deploy-on-vercel">Deploy on Vercel<a class="headerlink" href="#deploy-on
<script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
<script src="../../assets/javascripts/bundle.b4d07000.min.js"></script>


</body>
Expand Down

0 comments on commit 7d4fe8e

Please sign in to comment.