Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates for getting started, installation and updates sections #236

Merged
merged 65 commits into from Jun 13, 2018

Conversation

lisastreeter
Copy link
Collaborator

No description provided.

@mglaman
Copy link
Collaborator

mglaman commented May 25, 2018

will a comment kick off P.sH?

@lisastreeter
Copy link
Collaborator Author

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

@mglaman
Copy link
Collaborator

mglaman commented May 29, 2018

@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 mglaman requested review from bojanz and mglaman June 5, 2018 02:39
Copy link
Collaborator

@mglaman mglaman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@@ -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]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

[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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -0,0 +1,55 @@
---
title: Getting help
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


### Requirements

-Commerce 2.x requires Drupal 8.5.0 or newer.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should add:

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


-Commerce 2.x requires Drupal 8.5.0 or newer.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


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].
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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".

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


```
php_packages_extra:
- php7.1-bcmath
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

- 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

The answers are in there

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

- 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


* [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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@lisastreeter
Copy link
Collaborator Author

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
Copy link
Collaborator

mglaman commented Jun 12, 2018

@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
Copy link
Collaborator

mglaman commented Jun 13, 2018

I hereby declare this to be merged! Amazing work!

@mglaman mglaman merged commit 34b31b1 into drupalcommerce:master Jun 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants