Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): adjustments to the documentation #7231

Merged
merged 10 commits into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/content/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Learn more
:::
::


## Products and Features

::grid{:columns='3'}
Expand All @@ -42,10 +43,10 @@ Learn more
:card{to="https://docs.storefrontui.io" title="Storefront UI" description="Implement your design system with our ready to customize UI elements built for e-commerce" icon="IconStorefrontUi" }

#section-5
:card{to="/cloud" title="Cloud" description="Deploy with confidence with production-grade cloud hosting for your Alokai applications" icon="ri:cloud-fill"}
:card{to="/cloud" title="Cloud" description="Deploy with confidence with production-grade Cloud Platform for your Alokai applications" icon="ri:cloud-fill"}

#section-6
:card{to="/console" title="Console" description="Deploy, monitor, and manage your storefront with our cloud hosting platform " icon="ri:community-line"}
:card{to="/console" title="Console" description="Deploy, monitor, analyze and manage your Alokai Application." icon="ri:community-line"}

#section-7
:card{to="/enterprise" title="Enterprise" description="Ready to take your storefront next to the next level? Reach out to sales to see how we can help you." icon="ri:store-3-fill"}
Expand Down
47 changes: 23 additions & 24 deletions docs/content/2.general/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ Learn how to set up your first Alokai project [here](/general/starting-new-proje

Building a storefront requires solving multiple domain-specific problems separately and ensuring these solutions work well together. It’s not an easy task associated with considerable risk. This is precisely what Alokai was built to help with.

We started in 2017 on Github and we're still true to our Open Source roots. **All of our core products are Open Source** under MIT license. We also have [extended offering for Enterprise customers](/enterprise).

:card{to="/general/basics/philosophy" title="Philosophy" description="Learn what principles we followed when building Alokai." icon="IconVsf"}


Expand All @@ -28,6 +26,7 @@ Alokai is not just one product. **We provide an ecosystem of independent develop
- **Integrating third-party vendors** into your API orchestration and storefront.
- **Managing infrastructure, CI/CD pipelines, and deployments** to keep the application fast and reliable even under heavy loads.
- **Implementing engineering and architecture best practices** ensures that the project remains flexible and maintainable even on a large scale.
- **Decoupling frontend from underlying backend systems** so you don't have to reinvest into it every time you update or change some of them.
::

We will help you with all of the above and more. Our large ecosystem of developer tools and integrations will accelerate and simplify your development process without compromising quality and flexibility.
Expand All @@ -41,13 +40,6 @@ We will help you with all of the above and more. Our large ecosystem of develope
:card{to="/general/basics/data-flow" title="Data Flow" description="Understand how Alokai connects your storefront to various services" icon="ph:flow-arrow-bold"}
::

## Extending Alokai

Alokai is built for custom use cases. It's safe to say that with Alokai you are able to build the same things that you could build from scratch.

:card{to="/general/basics/extensibility" title="Extensibility" description="Learn how Alokai can be adjusted to your needs" icon="fa6-solid:layer-group"}


## Our Products

With Alokai's Middleware and SDK, you can connect to different platforms and services. Our Storefront UI Design System and ready Storefronts will save you from repetitive groundwork and set your project for success.
Expand All @@ -63,29 +55,36 @@ With Alokai's Middleware and SDK, you can connect to different platforms and ser

#section-3
:card{to="https://docs.storefrontui.io" title="Storefront UI" description="Our open-source component library built for e-commerce" icon="IconStorefrontUi"}

#section-4
:card{to="https://docs.storefrontui.io" title="Cloud Platform" description="Deploy with confidence with production-grade Cloud Platform for your Alokai applications" icon="material-symbols:cloud"}

#section-5
:card{to="https://docs.storefrontui.io" title="Console" description="Deploy, monitor, analyze and manage your Alokai Application." icon="material-symbols:frame-inspect"}
::

## Integrations
## Unified Data Layer

Our products are integrated with leading eCommerce and MACH vendors.
In the world of eCommerce, businesses often find themselves shifting between various platforms like commercetools, SAP Commerce Cloud, BigCommerce, and others.

:card{to="/integrations" title="Integrations" description="See available integrations" icon="fluent:puzzle-cube-piece-20-filled"}
Since each platform has its own unique data structure and APIs, migrating from one platform to another can be a long and error-prone process. The Unified Data Layer can help you solve this challenge by providing standardized data structures and methods that work across multiple platforms.

## Demo
The Unified Data Layer helps standardize two key aspects of eCommerce applications:

Our demo Storefront is using:
* **Unified Data Model** - standardized data structures for common eCommerce elements
* **Unified Methods** - standardized API calls for eCommerce operations

- React/Next.js
- Commercetools
- Storefront UI 2
- Alokai Middleware
- Alokai SDK
:card{to="/unified-data-layer" title="Unified data Layer" description="Read how Unified Data Layer can future-proof your frotnend and reduce the effort of backend system updates and migrations" icon="fluent:puzzle-cube-piece-20-filled"}

<img src="/img/basics/demo.png" alt="Alokai Demo" class="mx-auto">
## Extending Alokai

Alokai is built for custom use cases. It's safe to say that with Alokai you are able to build the same things that you could build from scratch.

:card{to="/general/basics/extensibility" title="Extensibility" description="Learn how Alokai can be adjusted to your needs" icon="fa6-solid:layer-group"}

## Integrations

Our products are integrated with leading eCommerce and MACH vendors.

:card{to="/integrations" title="Integrations" description="See available integrations" icon="fluent:puzzle-cube-piece-20-filled"}

::grid{:columns="2"}
#section-1
:card{to="https://demo.vuestorefront.io" title="Demo" description="Check out our demo storefront to see how a generic Alokai project look like" icon="pepicons-pencil:internet"}
::
36 changes: 6 additions & 30 deletions docs/content/2.general/2.starting-new-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,14 @@ layout: default

# Starting new project

::info Open Source integrations use old architecture
Temporarily Open Source integrations use old architecture based on Nuxt 2. We are working closely with their maintainers on updating them to the latest version of Nuxt 3 and Alokai SDK. You can find documentation for the old integrations [here](https://docs.alokai.com/v2). Feel free to reach out to us on [Discord](https://discord.alokai.com) if you want to learn more.
::

To start new Alokai project simply run our CLI.
```bash
npx @vue-storefront/cli init
```

Our friendly configurator will ask a few questions and set up a fresh Alokai project for you. Your project is a fully-functional eCommerce storefront connected to the eCommerce platform of your choice.
## Enterprise Integrations

```
β”Œ Welcome to Alokai 2 CLI! πŸ’š
β”‚
β—‡ πŸš€ What's your project name?
β”‚ my-vsf-project
β”‚
β—† βš™οΈ Choose an integration template:
β”‚ ● Magento 2
β”‚ β—‹ Shopify
β”‚ β—‹ Vendure
β”‚ β—‹ Kibo Commerce (beta)
β”‚ β—‹ Odoo
β”‚ β—‹ Prestashop
β”‚ β—‹ Spree
β”‚ β—‹ Custom integration
β””
Most of our integrations are available as part of Alokai Enterprise offering along with Alokai Frontend as A Service Platform. You can learn more or book a demo [here](/enterprise).

```
## Open Source user

Once you're set up, check relevent [integration docs](/integrations) for the next steps.
[Some of our eCommerce integrations](/integrations) are available in an Open Source model under MIT licenses. These integrations use Alokai core but are maintained by different companies.

## Enterprise Integrations
Even though we closely collaborate with their creators, we cannot provide any support for these integrations as Alokai. When seeking support please use our [Discord Channel](https://discord.alokai.com).

Only Open Source integrations are available in the CLI. If you want to access Enterprise integrations check out our [Enterprise offering](/enterprise).
You can find installation instructions for open-source integrations in the respective docs.
18 changes: 9 additions & 9 deletions docs/content/2.general/3.basics/2.philosophy.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ We will help you with all of the above and more. Our large ecosystem of develope

Headless and Composable architectures are meant for tailored solutions. Instead of living with trade-offs of your monolithic eCommerce vendor you're choosing more granular tools that are best-suited to your needs. This way you can work more effectvely than your competitors.

Same rule applies to your storefront. This is the part of the system that your customers will interact with the most. Instead of showing them a generic storefront with mediocre performace you have a chance to stand out and deliver outstanding user experience that they'll remember.
The same rule applies to your storefront. This is the part of the system that your customers will interact with the most. Instead of showing them a generic storefront with mediocre performace you have a chance to stand out and deliver outstanding user experience that they'll remember.

After browsing countless landing pages of WYSIWYG Page Builders developers often come to the conslusion that **available tools are too limiting** and the only way to achieve outstanding user experience is building the storefront from scratch.

Expand All @@ -34,14 +34,6 @@ We've built Alokai precisely for this kind of developer.Β **With Alokai you are

:card{to="/general/basics/extensibility" title="Extensibility" description="Learn about the flexibility and extensibility of Alokai." icon="fa6-solid:layer-group"}

## We believe in Open Source

We believe that the best solutions are built when people with different skillsets and perspectives can collaborate together. Alokai started in 2017 as Open Source project and quickly became one of the [most popular eCommerce repository on GitHub](https://github.com/topics/ecommerce). All of our core products are free and Open Source under MIT license.

On top of our Open Source products we offer Enterprise-grade support and integrations for more demainding customers aka. [Alokai Enterprise](/enterprise).

:card{to="https://github.com/vuestorefront" title="See our Github" description="Browse our Open Source repositories. Maybe you'd like to become a Alokai contributor? " icon="grommet-icons:github"}

## We aim for the best Developer Experience on the market

If you ever worked with enterprise-grade software you know very well that it's usually not the most "exciting"" tooling to use. Enterprise-grade software focuses on flexibility and risk mitigation but it often comes with the cost of decreased developer experience and productivity.
Expand All @@ -53,3 +45,11 @@ Our goal at Alokai is to deliver software that is as flexible and reassuring as
We want to take all the repetitive groundwork from you, set solid architectural foundations for your project that will set you for success and let you focus on the custom stuff that will make your project stand out.

**We want developers to say with full confidence after using our software that we deliver the best developer experience in the eCommerce market.** We know that it's an ambitious goal and we know that it's not gonna happen overnight but we will to keep improving our tools until that happens.

## We believe in Open Source

We believe that the best solutions are built when people with different skillsets and perspectives can collaborate together. Alokai started in 2017 as Open Source project and quickly became one of the [most popular eCommerce repositories on GitHub](https://github.com/topics/ecommerce). All of our core products are Open Source under BSD-3 license.

On top of our Open Source products we offer Enterprise-grade support, infrastructure and integrations for more demainding customers aka. [Alokai Enterprise](/enterprise).

:card{to="https://github.com/vuestorefront" title="See our Github" description="Browse our Open Source repositories. Maybe you'd like to become a Alokai contributor? " icon="grommet-icons:github"}
3 changes: 2 additions & 1 deletion docs/content/2.general/3.basics/3.architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ Let’s see how our products fit into the typical headless architecture. Each ad
- [**Storefront UI**](https://docs.storefrontui.io) (White-label Design System) - UI development acceleration with Vue / React components and Figma design.
- [**SDK**](/sdk) (Frontend integration layer) - Ensures the connection with Middleware is stable, and responses are fully typed.
- [**Middleware**](/middleware) (Backend integration layer) - Connects third-party vendors and exposes a single API for the frontend.
- [**Console**](/console) - (Hosting and monitoring platform) - Multi-region SaaS hosting platform for your storefront and middleware with observability monitoring and analytics
- [**Unified Data Layer**](/unified-data-layer) (Data Model) - Fully decouples your storefront from the underlying API's simplifying use cases such as migration to a new backend, updates or multi-vendor setups.
- [**Console and Cloud**](/console) - (Cloud and monitoring platform) - Multi-region SaaS Cloud Platform for your Alokai Application with observability, monitoring, analytics and more.
- [**Storefront**](/storefront) (Project Accelerator) - A ready-to-use Storefront Accelerator that is using all of the above products and is already connected to your eCommerce, CMS, Search and Payment vendors (we will talk about integrations in a moment!)

Storefront UI, SDK, Middleware, and Console are the barebones of your Alokai application. Using them ensures that you’re applying state-of-the-art architecture that will protect the scalability and flexibility of your project.
Expand Down
4 changes: 3 additions & 1 deletion docs/content/2.general/3.basics/4.data-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ On the Frontend layer, you call one of Alokai SDK methods (eg. `sdk.sapcc.getPro
**Middleware**

Alokai Middleware makes a REST call to the external API and returns the data retrieved from it.

In most cases, there is also a Unified Middleware extension there that translates native data models from the underlying API to the [Unified Data Model](/unified-data-layer).
::

<img alt="General Data Flow" src="/img/data-flow/general.svg" />
Expand Down Expand Up @@ -59,4 +61,4 @@ search({
},
});
```
<!-- [Here](todolink) you can read more about using GraphQL in Alokai. -->
<!-- [Here](todolink) you can read more about using GraphQL in Alokai. -->
22 changes: 13 additions & 9 deletions docs/content/2.general/3.basics/5.extensibility.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Extensibility

::card{title="Learn extensibility in practice" icon="tabler:tool" }

#description
Learn how to customize Alokai Application in practical examples.

#cta
:::docs-button{to="/guides/customization-next-js"}
Go to customization guide
:::
::

We are in the eCommerce business more than we remember, and we know that different elements of eCommerce architecture need different levels of customization. To balance acceleration coming from simplification with the ability to build custom experiences, we grouped our products into two categories:

- <span class="text-primary-500 font-bold">White Box</span> - AcceleratorsΒ that save you from generic and repetitive groundwork and provide direct access to the code. Once you set up the app, this becomes your own code.
Expand Down Expand Up @@ -79,6 +90,8 @@ Same way as SDK Module is a client-side part of the integration, API Client is a
// middlewareExtension.js
export const middlewareExtension = {
name: 'my-extension',
// use separate anmespace for API methods, false by default
isNamespaced: true,
// add new or override existing methods
extendApiMethods: {
customMethod: (context, params) => { /* ... */ },
Expand Down Expand Up @@ -114,14 +127,5 @@ export const integrations = {

<br />

::card{title="Learn extensibility in practice" icon="tabler:tool" }

#description
Learn how to customize Alokai in practical examples.

#cta
:::docs-button{to="/guides/customization-next-js"}
Go to customization guide
:::
::

Loading
Loading