From 54dadefd390f7dfb2705fcd46493f2a9648a0562 Mon Sep 17 00:00:00 2001 From: Krystian Wlodarski Date: Tue, 19 Mar 2024 10:32:12 +0100 Subject: [PATCH] Alokai refactor (#1504) * alokai rebranding * alokai rebranding * Delete docs/README.md --------- Co-authored-by: krystian wlodarski Co-authored-by: Wojciech Sikora <35867383+WojtekTheWebDev@users.noreply.github.com> --- README.md | 18 ++++++++++-------- docs/README.md | 22 ---------------------- packages/api-client/README.md | 13 ++++++++----- packages/load-tests/README.md | 4 ++-- 4 files changed, 20 insertions(+), 37 deletions(-) delete mode 100644 docs/README.md diff --git a/README.md b/README.md index 28d28ed57..66aae00f7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@
-   + +
+
@@ -12,25 +14,25 @@ -**This repository contains integration for Magento 2 and Vue Storefront Middleware.** +**This repository contains integration for Magento 2 and Alokai Middleware.** This integration is framework-agnostic and may be consumed in the framework of your choice. -## Magento 2 integration for Vue Storefront +## Magento 2 integration for Alokai -This project is a Magento 2 integration for Vue Storefront. +This project is a Magento 2 integration for Alokai. ### Check out [the docs](https://docs.vuestorefront.io/sdk-magento2/) # Quick start -Your Vue Storefront application has two parts: +Your Alokai application has two parts: 1. **Server Middleware** - an Express.js application that can connect to your various third-party services (like Magento). 2. **Front-end application** - any application using JavaScript or TypeScript that can connect to the server middleware. Popular choices include [Nuxt](https://nuxt.com/) and [Next.js](https://nextjs.org/). -In this section, we will explain in a step-by-step guide how to use Magento 2 integration in each part of your Vue Storefront application. +In this section, we will explain in a step-by-step guide how to use Magento 2 integration in each part of your Alokai application. ## Prerequisites @@ -271,12 +273,12 @@ Find more information about the module [GraphQl Custom Config](https://github.co ## Resources - [Magento 2 integration Documentation](https://docs.vuestorefront.io/sdk-magento2/) -- [Vue Storefront Documentation](https://docs.vuestorefront.io/v2/) +- [Alokai Documentation](https://docs.vuestorefront.io/v2/) - [Community Chat](http://discord.vuestorefront.io) ## Support -If you have any questions about this integration we will be happy to answer them on `magento2-vsf2` channel on [our Discord](http://discord.vuestorefront.io). +If you have any questions about this integration we will be happy to answer them on `magento2-alokai` channel on [our Discord](http://discord.vuestorefront.io). ## Contributors ✨ diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 495952b7e..000000000 --- a/docs/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# Vue Storefront Docs Starter - -Welcome to the Vue Storefront Docs Boilerplate! If you're creating a new Vue Storefront integration, this is the place to start. - -This Nuxt project can help you preview your content locally and get it ready to be merged into the Vue Storefront docs. - -It extends our [Base Layer](https://docs.vuestorefront.io/community/contributing/docs/base-layer) to give you all of the modules, components, and features available in the deployed Vue Storefront docs. - -Then, when you're ready to publish your content, we'll work with you to get add the `content` folder of this project as a remote Git source for the Vue Storefront docs. - -## Tips - -You can use the rest of this project to preview your content locally, but any components/layouts/composables/etc. will not be available to the published docs. - -If you need additional functionality, reach out to us on [Discord](https://discord.vuestorefront.io) and we'll work with you to get it added to the docs base layer and make it available to all of our docs projects. - -But remember - if you're publishing through the VSF docs, only your `content` folder will be pulled into the docs. - -### Place images directly in the `content` folder - -If you need to use images in your content, you can place them directly in the `content` folder. Then, you can reference them in your content using the relative path. - diff --git a/packages/api-client/README.md b/packages/api-client/README.md index 20070f2eb..f271eec13 100644 --- a/packages/api-client/README.md +++ b/packages/api-client/README.md @@ -1,14 +1,17 @@
-   + +
+
-## Vue Storefront 2 integration with Magento -### @vue-storefront/magento-api +## Alokai integration with Magento + +### @alokai/magento-api This is only the **api-client** package, you need to install the other dependencies also. -This project is a Magento 2 integration for Vue Storefront 2. +This project is a Magento 2 integration for Alokai. This integration developed by superheroes from [Caravel](https://github.com/caravelx) ❤️
@@ -81,7 +84,7 @@ Find more information about the module [GraphQl Custom Config](https://github.co ## Resources -- [Vue Storefront Documentation](https://docs.vuestorefront.io/v2/) +- [Alokai Documentation](https://docs.vuestorefront.io/v2/) - [Magento 2 integration Documentation (WIP)](https://docs.vuestorefront.io/magento) - [Community Chat](http://discord.vuestorefront.io) diff --git a/packages/load-tests/README.md b/packages/load-tests/README.md index e6e9073b6..00b371414 100644 --- a/packages/load-tests/README.md +++ b/packages/load-tests/README.md @@ -23,8 +23,8 @@ Please run tests locally before running on the cloud or comitting them to make s #### Accessing K6 web dashboard Before you ask the K6 cloud to run the tests for you, please make sure that: -1. You logged in at [app.k6.io](https://app.k6.io) with your VSF Google domain account -2. You were invited to the VSF K6 organization (K6 won't automatically add you to it - even though you're using your domain account) - ask Miłosz if you don't have access +1. You logged in at [app.k6.io](https://app.k6.io) with your Alokai Google domain account +2. You were invited to the Alokai K6 organization (K6 won't automatically add you to it - even though you're using your domain account) - ask Miłosz if you don't have access 3. In the sidebar in the top right, select the "Magento" project. That way you'll be able to access the test results.