Updates for getting started, installation and updates sections by lisastreeter · Pull Request #236 · drupalcommerce/commerce-docs

lisastreeter · 2018-05-24T23:26:05Z

No description provided.

Image files for recurring documentation

mglaman · 2018-05-25T14:25:14Z

will a comment kick off P.sH?

lisastreeter · 2018-05-26T19:53:37Z

If we have a "getting help" page, should probably include link to stack exchange in addition to issue queue and Slack.

mglaman · 2018-05-29T14:47:10Z

@lisastreeter that makes sense. Like the footer in https://www.drupaleurope.org/. And we should link to https://drupal.stackexchange.com/questions/tagged/drupal-commerce

mglaman

I read through most of it. This is great, thanks again @lisastreeter. There's probably some other nits which we could debate through, but I think it's a huge improvement.

mglaman · 2018-06-05T02:45:51Z

user/pages/03.commerce2/01.getting-started/01.using-composer/docs.md

@@ -11,7 +11,7 @@ distributable libraries that can be shared and integrated by others. This is
 possible in part by the PHP Framework Interoperability Group (FIG) and [PSR-4]


Whomp, my "SEO" hacks broke this page :( https://pr-236-4wo45ci-boljpk23hsit6.eu.platform.sh/commerce2/developer-guide/install-update/using-composer

I'll try to fix.

This is fixed, but the page shows a 404 on Platform.sh but not locally, which is weird.

mglaman · 2018-06-05T02:46:55Z

user/pages/03.commerce2/01.getting-started/02.getting-help/docs.md

+[Patching section](../../02.developer-guide/02.install-update/07.patching) of this documentation
+guide for information about applying patches.
+
+## Chat with the Drupal Commerce community using Slack


Maybe we can make it more concise: "Chat with us on Slack"

See it in its current length: https://pr-236-4wo45ci-boljpk23hsit6.eu.platform.sh/commerce2/getting-started/getting-help

mglaman · 2018-06-05T02:48:15Z

user/pages/03.commerce2/01.getting-started/02.getting-help/docs.md

@@ -0,0 +1,55 @@
+---
+title: Getting help


I agree about linking to https://drupal.stackexchange.com/. For instance, Ryan is 💯 there whereas Bojan and I are more active on Slack.

mglaman · 2018-06-05T02:51:17Z

user/pages/03.commerce2/02.developer-guide/02.install-update/01.requirements/docs.md

+
+ ### Requirements
+
+ -Commerce 2.x requires Drupal 8.5.0 or newer.


Maybe we should add:

"Generally we require each minor release, as it contains improvements that we use, or to reduce our code base."

mglaman · 2018-06-05T02:51:56Z

user/pages/03.commerce2/02.developer-guide/02.install-update/01.requirements/docs.md

+
+ -Commerce 2.x requires Drupal 8.5.0 or newer.
+
+ Unless you are building a very simple site, you will normally want to develop


We should recommend they always develop locally, to properly take advantage of Drupal's configuration management. Or just remove this in general

mglaman · 2018-06-05T02:53:06Z

user/pages/03.commerce2/02.developer-guide/02.install-update/01.requirements/docs.md

+
+ If you already have a web server, make sure it satisfies [Drupal 8’s requirements].
+ The recommended memory limit is 256MB or more. For local development we recommend
+ [DDEV] (Docker-based), [Drupal VM] (advanced users), or [Acquia Dev Desktop] (beginners). You will also need [Composer].


I don't think we should call DrupalVM advanced.. we should just say it's Vagrant based. So we're offering a Docker solution, Vagrant.. and then "custom".

Also, Acquia Dev Desktop got abandoned in the meantime, so it's not safe to recommend it anymore.

mglaman · 2018-06-05T02:54:05Z

user/pages/03.commerce2/02.developer-guide/02.install-update/01.requirements/docs.md

+
+ ```
+ php_packages_extra:
+   - php7.1-bcmath


We should link to this search for if they need help: https://github.com/geerlingguy/drupal-vm/search?q=bcmath&type=Issues

I've seen people having issues.. before it was just php-bcmath.. now php7.1-bcmath or php7.2-bcmath

mglaman · 2018-06-05T02:59:29Z

user/pages/03.commerce2/02.developer-guide/02.install-update/02.installation/docs.md

+ - The `bin` folder contains [Drupal Console] binary.
+ - The `web` folder represents the document root.
+ - Composer commands are always run from the site root (`mystore` in this case).
+ - See the `project-base README`_ for more details.


Should we document here how to convert web to docroot if on Acquia? Or maybe there's already a resource for the drupal-composer project on that.

Ideally we'd link to an external resource, since it's not Commerce specific.

Here's an issue drupal-composer/drupal-project#64

The answers are in there

I think this specific comment is best: drupal-composer/drupal-project#64 (comment)

bojanz · 2018-06-05T13:53:54Z

user/pages/03.commerce2/02.developer-guide/02.install-update/02.installation/docs.md

-   Updating an existing module: `composer update drupal/address -–with-dependencies`
-
- See the `project-base README`_ for more details.
+ - The `bin` folder contains [Drupal Console] binary.


"contains the [Drupal Console] binary"
Do we also want to mention that phpunit is there?

We should say that it contains any library binaries, such as Console, PHPUnit, Behat, etc

bojanz · 2018-06-05T13:54:15Z

user/pages/03.commerce2/02.developer-guide/02.install-update/02.installation/docs.md

+ - The `bin` folder contains [Drupal Console] binary.
+ - The `web` folder represents the document root.
+ - Composer commands are always run from the site root (`mystore` in this case).
+ - See the `project-base README`_ for more details.


Ideally we'd link to an external resource, since it's not Commerce specific.

bojanz · 2018-06-05T13:55:31Z

user/pages/03.commerce2/02.developer-guide/02.install-update/04.uninstalling/docs.md

+Once all content has been removed, you can start uninstalling the commerce
+modules. You will only be able to uninstall a few at a time because of
+dependencies. For example, you will not be able to uninstall the base Commerce
+module until all other commerce modules are installed. Note: if you have


This is missing the "run cron" trick documented in https://www.drupal.org/project/commerce/issues/2791303

bojanz · 2018-06-05T13:57:02Z

user/pages/03.commerce2/02.developer-guide/02.install-update/06.extending/docs.md

+
+* [Commerce Shipping] makes it possible to ship physical products to your customers.
+* [Commerce Recurring] makes it possible to provide subscriptions and recurring billing.
+* [Commerce Variation Cart Form] provides an alternative add-to-cart form for specific use cases.


Let's not recommend Commerce Variation Cart Form. We'll be deprecating it with Commerce functionality in a future release, and our examples should be more major. Two examples are enough, if not, we can point to Product Bundle or Price list.

bojanz · 2018-06-05T13:58:01Z

user/pages/03.commerce2/02.developer-guide/02.install-update/07.patching/docs.md

+releases. If you are unfamiliar with the concept of patching, you can learn
+about [Patches] at drupal.org.
+
+You can use Composer to apply patches by modifying the `composer.json` file


This only works if they used composer create-project VS adding Commerce to a vanilla site. Should be clarified.

lisastreeter · 2018-06-09T14:56:13Z

Question: should "backing up your site" be included, either as an additional page in the "installation" section or as part of the "Maintaining" page?

mglaman · 2018-06-12T14:42:18Z

@lisastreeter I think we can skip backing up your site. Or just link to a Drupal.org handbook guide on the topic in "Maintaining" page

mglaman · 2018-06-13T01:28:36Z

I hereby declare this to be merged! Amazing work!

lisastreeter added 30 commits March 6, 2018 15:41

Create docs.md

4b57e90

Create docs.md

5b4af0c

Initial draft of subscriptions overview

4b4e41f

Initial edits

098f173

Create images directory

c697639

Uploaded images

f7acb62

Delete temp.txt

3d4a332

Updated image links

787d373

Formatting and other minor edits

4199073

Create docs.md

f6bb828

Minor edits

720d7b4

Create docs.md

61e890d

Minor edits

a40002c

Create docs.md

9498993

Minor edits, link fixes.

a5488cf

Create docs.md

c32ca59

Minor edits

a939bdf

Minor edits and link fixes.

e39a3c3

Create docs.md

0beb6a2

Minor edit and link fix

4308a63

Minor edits

fd9931c

Add image file via upload

01e6df2

Add image files via upload

e7472bf

Merge pull request #2 from lisastreeter/lisastreeter-recurring-2

271f35e

Image files for recurring documentation

Added new images to Create subscription page

02ac45b

Fixed image file name

14f05e3

Delete image file with wrong name

6e5716b

Fixed image file names

836a467

Fix image file name

48cec97

Delete misnamed image file

0b8f5c1

lisastreeter and others added 8 commits March 27, 2018 08:09

Billing schedule admin ui image

9abdab0

Merge remote-tracking branch 'upstream/master'

682d257

minor fixes and new quickstart page

9f8b831

added additional installation pages, updated links, etc.

4802df4

additional pages

a7b5e71

add getting help to getting started and fix link

575fe3f

revisions following review on github

d5ce36d

minor fixes

ec74ed6

Update chapter.md

035d826

mglaman requested review from bojanz and mglaman June 5, 2018 02:39

mglaman approved these changes Jun 5, 2018

View reviewed changes

mglaman added 2 commits June 5, 2018 08:50

Merge branch 'master' into install-update

567d61a

Adjust Slack heading

8bdd5ad

bojanz reviewed Jun 5, 2018

View reviewed changes

mglaman and others added 3 commits June 5, 2018 09:00

Fix markdown

86e73e4

changes following mglaman/bojan review

07ac28b

updates following a review of DC issue #2896141 (composer usage)

efee4ef

Lisa Streeter added 3 commits June 12, 2018 12:57

added path to extending page, backup doc link to maintaining page

94e15a7

integrate instructions for using Ludwig

64f5e38

add composer version recommendation

be192d3

mglaman merged commit 34b31b1 into drupalcommerce:master Jun 13, 2018

This was referenced Jun 13, 2018

"Using Composer" is 404 on Platform, works locally. #241

Closed

Update to installation docs #237

Closed

		@@ -11,7 +11,7 @@ distributable libraries that can be shared and integrated by others. This is
		possible in part by the PHP Framework Interoperability Group (FIG) and [PSR-4]


		### Requirements

		-Commerce 2.x requires Drupal 8.5.0 or newer.


		-Commerce 2.x requires Drupal 8.5.0 or newer.

		Unless you are building a very simple site, you will normally want to develop

Conversation

lisastreeter commented May 24, 2018

Uh oh!

mglaman commented May 25, 2018

Uh oh!

lisastreeter commented May 26, 2018

Uh oh!

mglaman commented May 29, 2018

Uh oh!

mglaman left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lisastreeter commented Jun 9, 2018

Uh oh!

mglaman commented Jun 12, 2018

Uh oh!

mglaman commented Jun 13, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants