Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rap1ds committed May 28, 2024
1 parent 6e2fa65 commit e747166
Show file tree
Hide file tree
Showing 16 changed files with 88 additions and 60 deletions.
34 changes: 17 additions & 17 deletions _docpress.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"toc": {
"sections": [
{
"title": "Sharetribe Flex Integration SDK for JavaScript",
"title": "Sharetribe Integration SDK for JavaScript",
"source": "README.md",
"url": "index.html",
"slug": "index",
Expand Down Expand Up @@ -257,8 +257,8 @@
"index": {
"index.html": {
"source": "README.md",
"title": "Sharetribe Flex Integration SDK for JavaScript",
"pageTitle": "Sharetribe Flex Integration SDK for JavaScript",
"title": "Sharetribe Integration SDK for JavaScript",
"pageTitle": "Sharetribe Integration SDK for JavaScript",
"slug": "index",
"headings": [
{
Expand Down Expand Up @@ -305,19 +305,19 @@
},
"features.html": {
"source": "docs/features.md",
"title": "Features - Sharetribe Flex Integration SDK for JavaScript",
"title": "Features - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Features",
"slug": "features"
},
"try-it-in-command-line.html": {
"source": "docs/try-it-in-command-line.md",
"title": "Try it in command-line! - Sharetribe Flex Integration SDK for JavaScript",
"title": "Try it in command-line! - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Try it in command-line!",
"slug": "try-it-in-command-line"
},
"authentication.html": {
"source": "docs/authentication.md",
"title": "Authentication - Sharetribe Flex Integration SDK for JavaScript",
"title": "Authentication - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Authentication",
"slug": "authentication",
"headings": [
Expand All @@ -335,7 +335,7 @@
},
"calling-the-api.html": {
"source": "docs/calling-the-api.md",
"title": "Calling the API - Sharetribe Flex Integration SDK for JavaScript",
"title": "Calling the API - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Calling the API",
"slug": "calling-the-api",
"headings": [
Expand Down Expand Up @@ -392,37 +392,37 @@
},
"types.html": {
"source": "docs/types.md",
"title": "Types - Sharetribe Flex Integration SDK for JavaScript",
"title": "Types - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Types",
"slug": "types"
},
"configurations.html": {
"source": "docs/configurations.md",
"title": "Configurations - Sharetribe Flex Integration SDK for JavaScript",
"title": "Configurations - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Configurations",
"slug": "configurations"
},
"your-own-types.html": {
"source": "docs/your-own-types.md",
"title": "Your own types - Sharetribe Flex Integration SDK for JavaScript",
"title": "Your own types - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Your own types",
"slug": "your-own-types"
},
"serializing-types-to-json.html": {
"source": "docs/serializing-types-to-json.md",
"title": "Serializing types to JSON - Sharetribe Flex Integration SDK for JavaScript",
"title": "Serializing types to JSON - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Serializing types to JSON",
"slug": "serializing-types-to-json"
},
"object-query-parameters.html": {
"source": "docs/object-query-parameters.md",
"title": "Object query parameters - Sharetribe Flex Integration SDK for JavaScript",
"title": "Object query parameters - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Object query parameters",
"slug": "object-query-parameters"
},
"token-store.html": {
"source": "docs/token-store.md",
"title": "Token store - Sharetribe Flex Integration SDK for JavaScript",
"title": "Token store - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Token store",
"slug": "token-store",
"headings": [
Expand Down Expand Up @@ -457,13 +457,13 @@
},
"keep-alive.html": {
"source": "docs/keep-alive.md",
"title": "Keep-Alive - Sharetribe Flex Integration SDK for JavaScript",
"title": "Keep-Alive - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Keep-Alive",
"slug": "keep-alive"
},
"rate-limits.html": {
"source": "docs/rate-limits.md",
"title": "Rate limits - Sharetribe Flex Integration SDK for JavaScript",
"title": "Rate limits - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Rate limits",
"slug": "rate-limits",
"headings": [
Expand All @@ -486,13 +486,13 @@
},
"uploading-images.html": {
"source": "docs/uploading-images.md",
"title": "Uploading images - Sharetribe Flex Integration SDK for JavaScript",
"title": "Uploading images - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Uploading images",
"slug": "uploading-images"
},
"developing-sdk.html": {
"source": "docs/developing-sdk.md",
"title": "Developing SDK - Sharetribe Flex Integration SDK for JavaScript",
"title": "Developing SDK - Sharetribe Integration SDK for JavaScript",
"pageTitle": "Developing SDK",
"slug": "developing-sdk"
}
Expand Down
8 changes: 4 additions & 4 deletions authentication.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="stylesheet" href="styles.css?t=6eea839d">
<script src="assets/script.js?t=93f1a66c"></script>
<script src="scripts.js?t=a9970145"></script>
<title>Authentication - Sharetribe Flex Integration SDK for JavaScript</title>
<title>Authentication - Sharetribe Integration SDK for JavaScript</title>
<meta name="viewport" content="width=device-width">
<script>if (false || window.location.hostname.indexOf("sharetribe.github.io") === window.location.hostname.length - 20) {
(function(d,o,c,p,r,e,s){d['GoogleAnalyticsObject']=r;d[r]=d[r]||function(){(d[r].q=d[r].q||[]).push(arguments)},d[r].l=1*new Date();e=o.createElement(c),s=o.getElementsByTagName(c)[0];e.async=1;e.src=p;s.parentNode.insertBefore(e,s)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
Expand All @@ -21,7 +21,7 @@
<ul>
<li class="menu-item -level-0 -parent">
<ul class="submenu">
<li class="menu-item -level-1"><a class="link title link-index" href="index.html">Sharetribe Flex Integration SDK for JavaScript</a>
<li class="menu-item -level-1"><a class="link title link-index" href="index.html">Sharetribe Integration SDK for JavaScript</a>
</li>
<li class="menu-item -level-1"><a class="link title link-features" href="features.html">Features</a>
</li>
Expand Down Expand Up @@ -77,12 +77,12 @@
</div>
<div class="markdown-body"><h1 id="authentication">Authentication</h1>
<p>The SDK is ready to make API calls as soon as it is instantiated. It will
automatically use the Flex Authentication API to obtain access and refresh
automatically use the Sharetribe Authentication API to obtain access and refresh
tokens.</p>
<h2 id="revoke-refresh-token">Revoke refresh token</h2>
<p><strong><code>integrationSdk.revoke() : Promise</code></strong></p>
<p>Revokes the current refresh token and returns a Promise.</p>
<p>The SDK automatically obtains access and refresh tokens from the <a href="https://www.sharetribe.com/api-reference/authentication.html">Flex
<p>The SDK automatically obtains access and refresh tokens from the <a href="https://www.sharetribe.com/api-reference/authentication.html">Sharetribe
Authentication
API</a>. It uses the
configured <a href="token-store.html">token store</a> to hold the tokens. If the store is
Expand Down
4 changes: 2 additions & 2 deletions calling-the-api.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="stylesheet" href="styles.css?t=6eea839d">
<script src="assets/script.js?t=93f1a66c"></script>
<script src="scripts.js?t=a9970145"></script>
<title>Calling the API - Sharetribe Flex Integration SDK for JavaScript</title>
<title>Calling the API - Sharetribe Integration SDK for JavaScript</title>
<meta name="viewport" content="width=device-width">
<script>if (false || window.location.hostname.indexOf("sharetribe.github.io") === window.location.hostname.length - 20) {
(function(d,o,c,p,r,e,s){d['GoogleAnalyticsObject']=r;d[r]=d[r]||function(){(d[r].q=d[r].q||[]).push(arguments)},d[r].l=1*new Date();e=o.createElement(c),s=o.getElementsByTagName(c)[0];e.async=1;e.src=p;s.parentNode.insertBefore(e,s)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
Expand All @@ -21,7 +21,7 @@
<ul>
<li class="menu-item -level-0 -parent">
<ul class="submenu">
<li class="menu-item -level-1"><a class="link title link-index" href="index.html">Sharetribe Flex Integration SDK for JavaScript</a>
<li class="menu-item -level-1"><a class="link title link-index" href="index.html">Sharetribe Integration SDK for JavaScript</a>
</li>
<li class="menu-item -level-1"><a class="link title link-features" href="features.html">Features</a>
</li>
Expand Down
6 changes: 3 additions & 3 deletions configurations.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="stylesheet" href="styles.css?t=6eea839d">
<script src="assets/script.js?t=93f1a66c"></script>
<script src="scripts.js?t=a9970145"></script>
<title>Configurations - Sharetribe Flex Integration SDK for JavaScript</title>
<title>Configurations - Sharetribe Integration SDK for JavaScript</title>
<meta name="viewport" content="width=device-width">
<script>if (false || window.location.hostname.indexOf("sharetribe.github.io") === window.location.hostname.length - 20) {
(function(d,o,c,p,r,e,s){d['GoogleAnalyticsObject']=r;d[r]=d[r]||function(){(d[r].q=d[r].q||[]).push(arguments)},d[r].l=1*new Date();e=o.createElement(c),s=o.getElementsByTagName(c)[0];e.async=1;e.src=p;s.parentNode.insertBefore(e,s)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
Expand All @@ -21,7 +21,7 @@
<ul>
<li class="menu-item -level-0 -parent">
<ul class="submenu">
<li class="menu-item -level-1"><a class="link title link-index" href="index.html">Sharetribe Flex Integration SDK for JavaScript</a>
<li class="menu-item -level-1"><a class="link title link-index" href="index.html">Sharetribe Integration SDK for JavaScript</a>
</li>
<li class="menu-item -level-1"><a class="link title link-features" href="features.html">Features</a>
</li>
Expand Down Expand Up @@ -135,7 +135,7 @@

<span class="pl-c">// Allow use of Client Secret in browser (optional, defaults to false)</span>
<span class="pl-c">//</span>
<span class="pl-c">// Sharetribe Flex Integration SDK is meant to be used in a secure context, e.g.</span>
<span class="pl-c">// Sharetribe Integration SDK is meant to be used in a secure context, e.g.</span>
<span class="pl-c">// in a private Node.js server. Using it in an open website exposes the</span>
<span class="pl-c">// Client Secret to the public.</span>
<span class="pl-c">//</span>
Expand Down
27 changes: 22 additions & 5 deletions developing-sdk.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="stylesheet" href="styles.css?t=6eea839d">
<script src="assets/script.js?t=93f1a66c"></script>
<script src="scripts.js?t=a9970145"></script>
<title>Developing SDK - Sharetribe Flex Integration SDK for JavaScript</title>
<title>Developing SDK - Sharetribe Integration SDK for JavaScript</title>
<meta name="viewport" content="width=device-width">
<script>if (false || window.location.hostname.indexOf("sharetribe.github.io") === window.location.hostname.length - 20) {
(function(d,o,c,p,r,e,s){d['GoogleAnalyticsObject']=r;d[r]=d[r]||function(){(d[r].q=d[r].q||[]).push(arguments)},d[r].l=1*new Date();e=o.createElement(c),s=o.getElementsByTagName(c)[0];e.async=1;e.src=p;s.parentNode.insertBefore(e,s)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
Expand All @@ -21,7 +21,7 @@
<ul>
<li class="menu-item -level-0 -parent">
<ul class="submenu">
<li class="menu-item -level-1"><a class="link title link-index" href="index.html">Sharetribe Flex Integration SDK for JavaScript</a>
<li class="menu-item -level-1"><a class="link title link-index" href="index.html">Sharetribe Integration SDK for JavaScript</a>
</li>
<li class="menu-item -level-1"><a class="link title link-features" href="features.html">Features</a>
</li>
Expand Down Expand Up @@ -93,25 +93,42 @@ <h4 id="build-the-docpress-docs">Build the docpress docs</h4>
<pre><code class="lang-sh">$ yarn run build-docs
</code></pre>
<h4 id="update-the-github-pages">Update the Github Pages</h4>
<pre><code class="lang-sh">$ yarn run build-docs
<pre><code class="lang-sh">$ git checkout master
$ yarn run build-docs
$ mv _docpress ../
$ git checkout gh-pages
$ cp -r ../_docpress/* ./
$ rm -r ../_docpress
$ // git add, commit, push
$ git add .
$ git commit -m <span class="pl-s">&quot;Update docs&quot;</span>
$ git push --force
$ git checkout master
</code></pre>
<h4 id="release-a-new-version-to-npm">Release a new version to NPM</h4>
<ol>
<li>
<p>Update version in <code>package.json</code> and <code>src/version.js</code></p>
<p>Update versions:</p>
<ul>
<li><code>package.json</code></li>
<li><code>src/version.js</code></li>
</ul>
</li>
<li>
<p>Make a new build (as <code>src/version.js</code> needs to be up-to-date in the build) and commit</p>
<pre><code class="lang-bash">yarn run build
</code></pre>
</li>
<li>
<p>Update <a href="http://CHANGELOG.md">CHANGELOG.md</a></p>
<ul>
<li>Move everything in Unreleased to the corresponding version section</li>
<li>Update the version links found at the very bottom of the <a href="http://CHANGELOG.md">CHANGELOG.md</a> file</li>
</ul>
</li>
<li>
<p>Commit and push</p>
</li>
<li>
<p>Login as <code>sharetribe</code> with <code>npm login</code></p>
<ul>
<li>check credentials from password manager</li>
Expand Down
6 changes: 3 additions & 3 deletions features.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="stylesheet" href="styles.css?t=6eea839d">
<script src="assets/script.js?t=93f1a66c"></script>
<script src="scripts.js?t=a9970145"></script>
<title>Features - Sharetribe Flex Integration SDK for JavaScript</title>
<title>Features - Sharetribe Integration SDK for JavaScript</title>
<meta name="viewport" content="width=device-width">
<script>if (false || window.location.hostname.indexOf("sharetribe.github.io") === window.location.hostname.length - 20) {
(function(d,o,c,p,r,e,s){d['GoogleAnalyticsObject']=r;d[r]=d[r]||function(){(d[r].q=d[r].q||[]).push(arguments)},d[r].l=1*new Date();e=o.createElement(c),s=o.getElementsByTagName(c)[0];e.async=1;e.src=p;s.parentNode.insertBefore(e,s)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
Expand All @@ -21,7 +21,7 @@
<ul>
<li class="menu-item -level-0 -parent">
<ul class="submenu">
<li class="menu-item -level-1"><a class="link title link-index" href="index.html">Sharetribe Flex Integration SDK for JavaScript</a>
<li class="menu-item -level-1"><a class="link title link-index" href="index.html">Sharetribe Integration SDK for JavaScript</a>
</li>
<li class="menu-item -level-1"><a class="link title -active link-features" href="features.html">Features</a>
</li>
Expand Down Expand Up @@ -85,7 +85,7 @@

</div>
<div class="footer-nav">
<div class="left"><a href="index.html"><span class="title">Sharetribe Flex Integration SDK for JavaScript</span></a></div>
<div class="left"><a href="index.html"><span class="title">Sharetribe Integration SDK for JavaScript</span></a></div>
<div class="right"><a href="try-it-in-command-line.html"><span class="label">Next: </span><span class="title">Try it in command-line!</span></a></div>
</div>
</div>
Expand Down
14 changes: 7 additions & 7 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="stylesheet" href="styles.css?t=6eea839d">
<script src="assets/script.js?t=93f1a66c"></script>
<script src="scripts.js?t=a9970145"></script>
<title>Sharetribe Flex Integration SDK for JavaScript</title>
<title>Sharetribe Integration SDK for JavaScript</title>
<meta name="viewport" content="width=device-width">
<script>if (false || window.location.hostname.indexOf("sharetribe.github.io") === window.location.hostname.length - 20) {
(function(d,o,c,p,r,e,s){d['GoogleAnalyticsObject']=r;d[r]=d[r]||function(){(d[r].q=d[r].q||[]).push(arguments)},d[r].l=1*new Date();e=o.createElement(c),s=o.getElementsByTagName(c)[0];e.async=1;e.src=p;s.parentNode.insertBefore(e,s)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
Expand All @@ -21,7 +21,7 @@
<ul>
<li class="menu-item -level-0 -parent">
<ul class="submenu">
<li class="menu-item -level-1"><a class="link title -active link-index" href="index.html">Sharetribe Flex Integration SDK for JavaScript</a>
<li class="menu-item -level-1"><a class="link title -active link-index" href="index.html">Sharetribe Integration SDK for JavaScript</a>
<ul class="headings heading-list">
<li class="heading-item -depth-2"><a class="hlink link-table-of-contents" href="#table-of-contents">Table of Contents</a>
</li>
Expand Down Expand Up @@ -87,8 +87,8 @@
<!-- span.title Open in GitHub--><span class="icon -github"></span></a>
</div>
</div>
<div class="markdown-body"><h1 id="sharetribe-flex-integration-sdk-for-javascript">Sharetribe Flex Integration SDK for JavaScript</h1>
<p>Use Sharetribe Flex Integration API with ease.</p>
<div class="markdown-body"><h1 id="sharetribe-integration-sdk-for-javascript">Sharetribe Integration SDK for JavaScript</h1>
<p>Use Sharetribe Integration API with ease.</p>
<p><a href="https://circleci.com/gh/sharetribe/flex-integration-sdk-js"><img src="https://circleci.com/gh/sharetribe/flex-integration-sdk-js.svg?style=svg&amp;circle-token=5d118cf6f162884ba97e421c29c94f5c848ba28a" alt="CircleCI"></a></p>
<h2 id="table-of-contents">Table of Contents</h2>
<ul>
Expand All @@ -100,7 +100,7 @@ <h2 id="table-of-contents">Table of Contents</h2>
<li><a href="#license">License</a></li>
</ul>
<h2 id="what-is-it">What is it?</h2>
<p>The SDK is the <strong>easiest</strong> way to interact with Sharetribe Flex Integration API.</p>
<p>The SDK is the <strong>easiest</strong> way to interact with Sharetribe Integration API.</p>
<p>It handles <strong>groundwork</strong> such as authentication, renewing authentication tokens
and serializing and deserializing data to and from JavaScript data structures.</p>
<p>This lets you to <strong>concentrate on building your integration</strong> instead
Expand Down Expand Up @@ -133,11 +133,11 @@ <h2 id="usage">Usage</h2>
});
</code></pre>
<p>Client ID and client secret are required to create a new SDK instance.
See <a href="https://www.sharetribe.com/docs/integrations/getting-started-with-integration-api/#create-integration-api-application-in-flex-console">this article</a>
See <a href="https://www.sharetribe.com/docs/introduction/getting-started-with-integration-api/#create-integration-api-application-in-sharetribe-console">this article</a>
to learn how to get them.</p>
<h2 id="examples">Examples</h2>
<p>See the
<a href="https://github.com/sharetribe/flex-integration-api-examples">flex-integration-api-examples</a>
<a href="https://github.com/sharetribe/integration-api-examples">integration-api-examples</a>
repository on GitHub.</p>
<h2 id="documentation">Documentation</h2>
<p><a href="https://sharetribe.github.io/flex-integration-sdk-js/">Documentation can be found
Expand Down
Loading

0 comments on commit e747166

Please sign in to comment.