Git Product home page Git Product logo

docs's Introduction

Mailchimp Developer

Mailchimp Open Commerce docs

This repo hosts the open source documentation for Mailchimp Open Commerce (formerly Reaction Commerce). Previous versions of the Reaction Commerce docs are archived in a separate repo.

Markdown and custom syntax

The files in this repo are the source content for the Open Commerce docs on the Mailchimp Developer site.

To render properly on the developer site, all docs should be written in Markdown. Some standard Markdown elements are not supported: avoid H3, H4, H5, and H6 headers, as well as nested lists.

The developer site does support some Markdown-compatible custom components:

Code snippets

Delimit code blocks with triple backticks as in standard Markdown. You can optionally add a GitHub-flavored Markdown language and a title parameter:

```js title=Example
console.log('hello world');
```

Custom code block

The title parameter cannot contain whitespace, so we recommend only using it for filenames, indicating the location of the referenced code.

Code blocks without a language and title are rendered in a plain module:

```
testing 1 2 3
```

Plain code block

Note blocks

Create custom note blocks by starting a blockquote with the string **Note**: :

> **Note**: hello there

Custom note block

Other blockquotes will be rendered normally:

> Hello there

Plain block quote

Contributing

Contributions to this repo are welcome. Please submit an issue or pull request if you feel any information is incomplete or inaccurate.

Approved changes will also be published on the Mailchimp Developer site, although they will not appear there immediately.

docs's People

Contributors

akarshit avatar alexmarple avatar delagroove avatar ecormany avatar mohannarayana avatar prichey avatar rondlite avatar spencern avatar zenweasel avatar

Stargazers

 avatar  avatar

Watchers

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

docs's Issues

Improve docs for folks using windows.

The quick start guide doesn't mention a lot about Windows. It would be nice to have a paragraph explaining the steps for Windows.

This would greatly reduce the number of queries we are getting on Discord related to this.

Developers Guide - Developer Concepts

  • Carts
  • Catalog and publishing
  • Fulfillment Groups
  • Inventory
  • Payments
  • Pricing
  • Products, variants and options
  • Multi-Shop
  • Tags
  • Understanding CommonOrder
  • Job Control

Getting Started Guide

The current guide is fine as it is, this is for the re-write for the new proposed flow.

Shop Manager Guide

  • Create your shop (briefly explain multi-tenant capabilities)
  • Create and publish a product (touch on what the catalog is)
  • Create a tag
  • Create the navigation
  • Configure a shipping methods
  • Configure taxes
  • Configure payments
  • Configure Email
  • Modify Email templates
  • Viewing/Searching Orders
  • Processing Orders/ Fulfillment
  • Create a User (you need to create one to log in)
  • Create a second shop and invite the shop owner
  • Creating a discount (does this even work?, can't figure out how to apply that discount to anything)
  • Address validation

Update make command to make init-dev.

A lot of queries on discord are about users trying to change stuff and their changes not being reflected. This is happening because the quick-start guide runs services in production mode.
Maybe we should start services in dev mode so that people can change things and view those changes.

Create a "How to write documentation for Open Commerce" doc

This should take what we learn from this first pass at documentation re: structure and organization, a lot of stuff from the Postlite doc but targeted towards the Open Source community and focused on just getting a PR merged into this repo

Developers Guide - Developing a Storefront

  • Add and configure Apollo client
  • Build a product listing page
  • Build a product detail page
  • Build navigation menus
  • Add a way to add an item to a cart
  • Build a cart page
  • Implement cart modification
  • Build a checkout page
  • Build an order view page
  • Add ability to log in
  • Add guest checkout functionality
  • Build an account management page

How To Guides

  • #45
  • Create a tax plugin
  • Create a fulfillment plugin
  • Create a promotions plugins (there may not be an extensibility point here)
  • Create an address validation service
  • Emit and listen for events
  • Extend an existing schema
  • Add extra data to a product
  • Add translations
  • Share code between plugins
  • Create a query
  • Create a mutation
  • Extend graphQL to add a field
  • Store custom order fields
  • Write a migration
  • Use Federation
  • Extend GraphQL with remote schema

Developers Guide - Developing for Core

  • Workflows
  • Setting up IDE
  • Environment variables
  • Using a graphQL client to test/explore endpoints
  • Plugin architecture fundamentals
  • Creating a plugin
  • Adding collections
  • Creating schemas
  • Writing unit tests
  • Writing integration tests
  • Understanding pagination
  • Writing and running migrations

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.