Skip to content

Commit

Permalink
No code assets improvements (#863)
Browse files Browse the repository at this point in the history
* Add mentions of the Asset Delivery API
* List available default asset files
  • Loading branch information
SariSaar authored Dec 4, 2024
1 parent 395f842 commit 2798bea
Show file tree
Hide file tree
Showing 6 changed files with 116 additions and 7 deletions.
23 changes: 16 additions & 7 deletions src/docs/concepts-development/console-overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,17 +86,22 @@ section. You can

### Build

In the build section you can modify some marketplace settings. The Build
section will mostly be used by your developer, so you might not need to
worry about this specific section of your marketplace. It’s good to know
the basics, nonetheless, so here is a brief overview of what the Build
section includes.
In the build section you can modify some marketplace settings, content,
and configurations without coding. When you have no-code content and
configurations set up in Console, you can use the
[Asset Delivery API](https://www.sharetribe.com/api-reference/asset-delivery-api.html)
to fetch them to your custom marketplace application.

- [Read more about retrieving asset data](/references/assets/#retrieving-asset-data)

**General** contains basic information about your marketplace: your
marketplace ID, URL and name. Here, you can also configure an outgoing
email address, where all notifications to your marketplace’s users will
be sent from.

Here, you can also set up your localization and access control no-code
configurations, which can be fetched as an asset.

<info>

Note that for marketplaces in custom code mode, marketplace name is not
Expand All @@ -110,13 +115,17 @@ defined through Console. Instead, you need to define it in the correct
configurations. You can
[modify your marketplace and email texts](/concepts/marketplace-texts/),
create [content pages](/concepts/headless-content-management/), and
configure your marketplace footer.
configure your marketplace footer and top bar.

**Design** allows you to modify the branding and layout of your
marketplace.

**Users** contains configurations related to your marketplace user types
and user fields.

**Listings** contains configurations related to your marketplace listing
types, listing fields, and listing search conventions.
types, listing categories, listing fields, and listing search
conventions.

**Transactions** related configurations include minimum transaction size
as well as provider and customer commissions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@ used to customise the template with low code effort. Starting in version
v2.0.0, the template can also use [asset-based](/references/assets/)
configurations, if they are defined in Sharetribe Console.

<info>

The
[Asset Delivery API](https://www.sharetribe.com/api-reference/asset-delivery-api.html)
is used to fetch no-code content and configurations, defined in the
Console, to your client application.
[See all the available assets.](/references/assets/#available-default-asset-files)

Sharetribe Web Template fetches mandatory assets by default.

</info>

Some configurations are mandatory to define in Sharetribe Console, such
as logo, listing types, listing fields, and minimum transaction size.
Those configurations are read from the hosted assets in the template by
Expand Down
12 changes: 12 additions & 0 deletions src/docs/introduction/getting-started-with-ftw-daily/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,18 @@ This will automatically open `http://localhost:3000` in a browser:

<info>

The Sharetribe Web Template fetches no-code content and configurations
from the Sharetribe backend using the
[Asset Delivery API](https://www.sharetribe.com/api-reference/asset-delivery-api.html).

Read more about how no-code assets are handled between the Sharetribe
Console and the client application in our
[asset reference documentation](/references/assets/).

</info>

<info>

As you browse your marketplace and create listings, you may notice that
the search filters do not work. You can activate the filters by creating
a
Expand Down
21 changes: 21 additions & 0 deletions src/docs/introduction/introducing-flex/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,27 @@ of the Integration API, visit the
about
[integrations in Sharetribe](/concepts/integrations-introduction/).

### The Asset Delivery API

The Asset Delivery API is how you can fetch your no-code content and
configurations, defined in Console, to your client application. To read
more about the capabilities of the Asset Delivery API, visit the
[Asset Delivery API reference documentation](https://www.sharetribe.com/api-reference/asset-delivery-api.html).
You can also read more in our
[asset reference article](/references/assets/).

### The Authentication API

The Authentication API is how you authenticate your API requests. All
requests to Marketplace API and Integration API require a valid token,
and tokens can provide different levels of access depending on their
type. If you are using the Javascript SDKs, authentication is handled
within the SDK tooling. To read more about the capabilities of
Authentication API, visit the
[API reference documentation](https://www.sharetribe.com/api-reference/authentication.html)
or read more in our
[Authentication API article](/concepts/authentication-api/).

### Sharetribe CLI

Sharetribe CLI (Command-line interface) is a tool for changing your
Expand Down
47 changes: 47 additions & 0 deletions src/docs/references/assets/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,53 @@ take up to 5 minutes before any changes are visible to all end users.

</info>

## Available default asset files

Assets are fetched by file path. The asset files available to be fetched
by default are the following:

### General

- Localization: `/general/localization.json`
- Access control: `/general/access-control.json`

### Content

- Content pages: `/content/pages/{pageId}.json`
- Top bar: `/content/top-bar.json`
- Footer: `/content/footer.json`
- Marketplace texts: `/content/translations.json`
- Email texts: `/content/email-texts.json`

### Design

- Branding: `/design/branding.json`
- Layout: `/design/layout.json`

### Users

- User types: `/users/user-types.json`
- User fields: `/users/user-fields.json`

### Listings

- Listing types: `/listings/listing-types.json`
- Listing categories: `/listings/listing-categories.json`
- Listing fields: `/listings/listing-fields.json`
- Listing search: `/listings/listing-search.json`

### Transactions

- Commission: `/transactions/commission.json`
- Minimum transaction size:
`/transactions/minimum-transaction-size.json`

### Integrations

- Map: `/integrations/map.json`
- Analytics: `/integrations/analytics.json`
- Google Search Console: `/integrations/google-search-console.json`

## Further reading

- [Editing client application marketplace texts](/concepts/marketplace-texts/)
Expand Down
8 changes: 8 additions & 0 deletions src/docs/tutorial-branding/copy-assets/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,11 @@ Biketribe marketplace.

You can now continue to develop your marketplace with the same
configurations you set up in Test!

### Further reading

The Sharetribe Web Template uses the
[Asset Delivery API](https://www.sharetribe.com/api-reference/asset-delivery-api.html)
to fetch your no-code content and configurations from the Sharetribe
backend to your application. Read more about handling no-code assets in
the [Assets reference](/references/assets/).

0 comments on commit 2798bea

Please sign in to comment.