Jelajahi Sumber

feat(docs): Add roadmap and FAQ

Michael Bromley 5 tahun lalu
induk
melakukan
40b681b322

+ 16 - 0
docs/assets/styles/_article.scss

@@ -0,0 +1,16 @@
+@import "variables";
+
+.article-toc {
+    #TableOfContents > ul {
+        list-style-type: none;
+        padding-left: 0;
+
+        > li > ul {
+            list-style-type: disc;
+            color: $gray-600;
+            > li {
+                margin-bottom: $padding-8;
+            }
+        }
+    }
+}

+ 1 - 0
docs/assets/styles/main.scss

@@ -1,6 +1,7 @@
 @import "variables";
 @import "markdown";
 @import "utils";
+@import "article";
 @import "landing-page";
 @import "top-bar";
 @import "menu";

+ 1 - 0
docs/config.toml

@@ -4,6 +4,7 @@ title = "Vendure E-commerce"
 googleAnalytics = "UA-133911942-1"
 pygmentsCodeFences = true
 pygmentsUseClasses = true
+enableGitInfo = true
 images = ["share-image.jpg"]
 disableKinds = [
   "taxonomy",

+ 46 - 0
docs/content/article/faq.md

@@ -0,0 +1,46 @@
+---
+title: "Vendure Frequently Asked Questions"
+weight: 0
+showtoc: true
+--- 
+ 
+## Vendure is still beta. Can I use it in production?
+
+Short answer: **yes**, Vendure can be (and is) used in production. However, there are a number of caveats which you must be aware of before deciding to use Vendure beta:
+
+1. Before Vendure reaches v1.0, breaking changes can and do occur with minor releases (e.g. between v0.10.0 and v0.11.0). These breaking changes are documented in the changelog entry that accompanies each release. Take a look at [the changelog](https://github.com/vendure-ecommerce/vendure/blob/master/CHANGELOG.md) to get a sense of the kinds of breaking changes that you can expect.
+2. Certain features which are planned for v1.0 are either not yet implemented, or are incomplete. The Roadmap section covers the main outstanding areas.
+3. As with any early-stage software, there will be edge-case bugs and rough edges that need finding and fixing. Be prepared to report issues and - if feasible - contribute to the ongoing development of the project.
+
+## When will Vendure come out of beta?
+
+Please see the [Vendure Roadmap]({{< relref "roadmap" >}}) for full details.
+
+## Can I use React/Vue/Gatsby/Next etc. with Vendure?
+
+**Yes**. Vendure is completely decoupled from the front-end storefront implementation. You are free to build your storefront using whatever technology you like.
+
+For example, there are already Vendure storefront projects built with Vue, React, Angular and Svelte.
+
+## Who is using Vendure?
+
+There are a number of Vendure projects under development at the moment. Based on community interactions, we know that Vendure is being used in both public B2C settings and enterprise B2B. Here are some live Vendure sites that we know of. Please get in touch if you'd like yours to be added!
+
+* [CB Made In Italy](https://cbmadeinitaly.com/): Vendure + [Vue Storefront](https://www.vuestorefront.io/)
+* [Racketworld.ch](https://racketworld.ch/): Vendure + [Svelte](https://svelte.dev/) + [Sapper](https://sapper.svelte.dev/)
+
+## Is enterprise support available?
+
+We're not yet offering general support packages, but if you are planning a Vendure-based project and are interested in consulting & code-review services from the core Vendure development team, please [get in touch](mailto:contact@vendure.io).
+
+## Is Vendure free to use?
+
+**Yes**. Vendure and all the core packages are licensed under the [MIT licence](https://github.com/vendure-ecommerce/vendure/blob/master/LICENSE). This means you are free to use Vendure without restriction, even as the basis of your own commercial product.
+
+## Does Vendure support multi-vendor / multi-tenant?
+
+**No**, out-of-the box Vendure does not support multi-vendor. We have a [Channels feature]({{< relref "channels" >}}) which allows a single vendor to define multiple sales channels. 
+
+It _would_ be possible to add multi-vendor support by way of a plugin, but bear in mind that this would entail a fair amount of custom development.
+
+An official multi-vendor plugin is under consideration for after the v1.0 release.

+ 29 - 0
docs/content/article/roadmap.md

@@ -0,0 +1,29 @@
+---
+title: "Vendure Roadmap"
+weight: 0
+showtoc: false
+---
+
+## Vendure beta ➡ v1.0
+
+Here is a list of some of the main outstanding tasks that are planned for the v1.0 release, at which point Vendure will come out of beta:
+
+* Complete the Channels implementation
+* Customer groups
+* Back order handling
+* Administrator creation & editing of orders
+* Custom authentication support
+* Improved promotions support
+* Improved tax calculation support
+* Improved support for running Vendure in cloud environments
+* Performance improvements
+
+We currently hope to **reach v1.0 in the latter half of 2020**. For an up-to-date overview of where we stand, refer to the [GitHub milestones page](https://github.com/vendure-ecommerce/vendure/milestones).
+
+## Post v1.0
+
+Once we hit v1.0, Vendure will continue to follow [Semantic Versioning](https://semver.org/). We'll aim for a steady cadence of major releases, perhaps every 6 months. Newer, breaking changes will be available via a `next` branch and release tag. 
+
+## Long-term
+
+Vendure is in this for the long-term. This is not a venture-backed start-up looking for an exit. We plan to grow Vendure into the go-to solution for Node.js e-commerce with a solid, stable core and vibrant community. Post v1.0 we will be introducing a set of commercial plugins covering some more advanced use-cases. 

+ 21 - 0
docs/layouts/article/baseof.html

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+{{- partial "docs/shared" -}}
+<html>
+
+<head>
+    {{ partial "docs/html-head" . }}
+    {{ template "_internal/opengraph.html" . }}
+    {{ template "_internal/twitter_cards.html" . }}
+</head>
+
+<body>
+<main class="container">
+    {{ template "main" . }}
+</main>
+
+{{ partial "top-bar" }}
+{{ partial "footer" }}
+{{ template "_internal/google_analytics_async.html" . }}
+</body>
+
+</html>

+ 23 - 0
docs/layouts/article/list.html

@@ -0,0 +1,23 @@
+{{ define "main" }}
+<div class="posts-list">
+    {{ partial "breadcrumbs" . }}
+    {{ $paginator := .Paginate (where .Pages "Params.hidden" "ne" true) }}
+    {{ range sort .Paginator.Pages }}
+    <article class="book-posts mx-auto">
+        <h2>
+            <a href="{{ .RelPermalink }}">{{ .Title }}</a>
+        </h2>
+        <h5>
+            <strong>{{ .Date.Format "January 2, 2006" }}</strong>
+        </h5>
+        <p>
+            {{- .Summary -}}
+            {{ if .Truncated }}
+            <a href="{{ .RelPermalink }}">...</a>
+            {{ end }}
+        </p>
+    </article>
+    {{ end }}
+    {{ template "_internal/pagination.html" . }}
+</div>
+{{ end }}

+ 23 - 0
docs/layouts/article/single.html

@@ -0,0 +1,23 @@
+{{ define "main" }}
+<div class="blog-post">
+    <header>
+        <h1>{{ .Title }}</h1>
+        <div class="details">
+            <div class="date">Last updated: {{ .Lastmod.Format "January 2, 2006" }}</div>
+        </div>
+    </header>
+    {{ $showToC := default (default true .Site.Params.BookShowToC) .Params.showtoc }}
+    {{ if and ($showToC) (.Page.TableOfContents) }}
+    <aside class="article-toc">
+        {{ .Page.TableOfContents }}
+    </aside>
+    {{ end }}
+    <article class="markdown">
+        {{- .Content -}}
+    </article>
+</div>
+{{ end }}
+
+{{ define "toc" }}
+{{ partial "docs/toc" . }}
+{{ end }}