Quellcode durchsuchen

Add warning about using old require paths until Lerna packages are live

Artur Paikin vor 6 Jahren
Ursprung
Commit
0bb7eefa35
2 geänderte Dateien mit 11 neuen und 0 gelöschten Zeilen
  1. 6 0
      README.md
  2. 5 0
      website/themes/uppy/layout/page.ejs

+ 6 - 0
README.md

@@ -25,6 +25,12 @@ Uppy is being developed by the folks at [Transloadit](https://transloadit.com),
 
 Code used in the above example:
 
+<blockquote>
+  <p>⚠️<strong>Attention:</strong> the docs have already been updated to use separate uppy packages, but we’ll actually publish those packages in the next few days. 
+  In the meantime, for correct require/import paths, please refer to the <a href="https://github.com/transloadit/uppy/tree/a35eb6e8f93cc07391dda87a0e4cc31d76783d0e/website/src/docs">0.25.6 documentation</a>.</p>
+  <p><strong>TL;DR</strong> use <code>uppy</code> package (<code>npm install uppy --save</code>) with paths like this: <code>require('uppy/lib/core')</code>, <code>require('uppy/lib/plugins/Dashboard')</code> and so on.</p>
+</blockquote>
+
 ```js
 const Uppy = require('@uppy/core')
 const Dashboard = require('@uppy/dashboard')

+ 5 - 0
website/themes/uppy/layout/page.ejs

@@ -3,6 +3,11 @@
 <% } %>
 <div class="Content js-Content <%- page.type ? page.type + ' with-sidebar' : '' %>">
     <h1><%- page.title %></h1>
+    <blockquote>
+      <p>⚠️<strong>Attention:</strong> the docs have already been updated to use separate uppy packages, but we’ll actually publish those packages in the next few days. 
+      In the meantime, for correct require/import paths, please refer to the <a href="https://github.com/transloadit/uppy/tree/a35eb6e8f93cc07391dda87a0e4cc31d76783d0e/website/src/docs">0.25.6 documentation</a>.</p>
+      <p><strong>TL;DR</strong> use <code>uppy</code> package (<code>npm install uppy --save</code>) with paths like this: <code>require('uppy/lib/core')</code>, <code>require('uppy/lib/plugins/Dashboard')</code> and so on.</p>
+    </blockquote>
     <%- page.content %>
     <% if (page.type === 'guide') { %>
       <div class="guide-links">