Git Product home page Git Product logo

commerce-cloud-tools's Introduction

Adobe Commerce Cloud Tools

This site contains the latest Adobe Commerce and Magento Open Source developer documentation for ongoing releases of Commerce Cloud Tools, including:

  • Cloud Docker for Commerce—For the Cloud Docker for Commerce source code, see the magento-cloud-docker repository.

Contributors

Our goal is to provide the Adobe Commerce and Magento Open Source communities with comprehensive and quality technical documentation. We believe that to accomplish that goal we need experts from the community to share their knowledge with us and each other. We are thankful to all of our contributors for improving the documentation.

See the Contribution Guide for details about contributing to Adobe Commerce and Magento Open Source developer documentation.

Local development

This repository is a Gatsby project that uses the Adobe I/O Theme.

Install the following for local documentation site builds:

To build and serve the site:

  1. Clone the repository and change to site directory.

  2. Enable the corepack package.

    corepack enable
  3. Set yarn to stable version and install.

    yarn set version stable
    yarn install
  4. Build site dependencies.

    The build command is useful for refreshing the build artifacts without serving the site, but yarn dev performs this step.

    yarn build
  5. Build site and serve preview on localhost.

    yarn dev

    Use CTRL + C to stop serving the site.

  6. Clean local build artifacts.

    yarn clean

Available Commands

Command Description
yarn build Compile site files.
yarn clean Clean build artifacts.
yarn dev Launch dev server preview.
yarn serve Serve the existing site files for testing preview.
yarn start Compile site files and serve for testing preview.
yarn test Test for broken links.

Resources

See the following resources to learn more about using the theme:

If you have questions, open an issue and ask us. We look forward to hearing from you!

commerce-cloud-tools's People

Contributors

andriyshevtsov avatar bados avatar bdenham avatar dependabot[bot] avatar dshevtsov avatar hguthrie avatar jeff-matthews avatar timkim avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

commerce-cloud-tools's Issues

Clarity around "....On macOS or Windows" on the "Synchronizing data in a Docker developer environment" doc

Is there an existing issue for this?

I copied this issue over from DevDocs: magento/devdocs#9536

  • I have searched the existing issues

Which topic?

https://developer.adobe.com/commerce/cloud-tools/docker/setup/synchronize-data/

What's wrong with the content?

This topic talks about the best configurations depending on OS, but it would be really helpful here if when it talks about "Windows" it clarified whether this is regardless of whether WSL is being used or not.

What changes do you propose?

For example, when it says....

On macOS or Windows hosts, this option results in extremely slow performance in the Docker environment.

Does this mean Windows regardless of whether WSL being used? If so then it could read...

On macOS or Windows hosts (both Windows native and Windows WSL 1 or 2), this option results in extremely slow performance in the Docker environment.

Anything else that can help to cover this?

I think I've seen other pages that this could be clarified on. So many people are using WSL now that I think this would be really helpful. It might also be necessary in some cases to distinguish between WSL 1 and 2, as these behave quite differently in terms of the file system.

Many thanks for considering this.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.