Skip to content
This repository has been archived by the owner on Oct 29, 2024. It is now read-only.

Commit

Permalink
#22, created way about documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
landsman committed Dec 10, 2017
1 parent 0696cd7 commit 51a057f
Show file tree
Hide file tree
Showing 8 changed files with 77 additions and 17 deletions.
7 changes: 7 additions & 0 deletions .docs/commerce.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Drupal Commerce

let's go shopping!

# Install

**@todo**
13 changes: 13 additions & 0 deletions .docs/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Development

OK, let's make something awesome!

## Docker

**@todo:**

## Custom theme

**@todo:**


11 changes: 11 additions & 0 deletions .docs/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Docker

**God bless virtualization!**

# Install on macOS

**@todo**

# Install on Ubuntu

**@todo**
8 changes: 8 additions & 0 deletions .docs/requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Requirements

Your localhost should looking ideally this way:

- Intel Core i5 and better
- more than 8 GB RAM
- Linux / macOS
- installed docker [install here](./.doc/docker.md)
20 changes: 20 additions & 0 deletions .docs/varnish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Varnish Cache

If you want to use [Varnish Cache](https://varnish-cache.org/) for your project, we are recommend these steps:

1. add varnish modules:
```
composer require drupal/purge
composer require drupal/purge_purger_http
```
2. allow them:
```
cd docroot
../bin/drush en purge -y
../bin/drush en purge_purger_http -y
```
3. setup modules
**@todo:** add screenshots about config
21 changes: 11 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# Ignore directories generated by Composer
/drush/contrib/
/vendor/
/web/core/
/web/modules/contrib/
/web/themes/contrib/
/web/profiles/contrib/
/web/libraries/
/docroot/core/
/docroot/modules/contrib/
/docroot/themes/contrib/
/docroot/profiles/contrib/
/docroot/libraries/

# Ignore sensitive information
/web/sites/*/settings.php
/web/sites/*/settings.local.php
/docroot/sites/*/settings.php
/docroot/sites/*/settings.local.php

# Ignore Drupal's file directory
/web/sites/*/files/
/docroot/sites/*/files/

# Ignore SimpleTest multi-site environment.
/web/sites/simpletest
/docroot/sites/simpletest

# Ignore files generated by PhpStorm
/.idea/
/.idea/
/bin/
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ composer create-project studioartcz/drupal domain.local --stability dev --no-int
```
<sup>* domain.local is your virtual host folder</sup>

and for next steps please follow our [development manual](./doc/development.md).
and for next steps please follow our [development manual](./.doc/development.md).

## What this stack solving?

Expand Down
12 changes: 6 additions & 6 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "studioartcz/drupal",
"description": "Drupal 8 development stack for usually cases like a middle websites, magazines",
"type": "project",
"license": "MIT",
"license": "GPL-2.0+",
"repositories": [
{
"type": "composer",
Expand Down Expand Up @@ -85,11 +85,11 @@
],
"installer-paths": {
"drush/contrib/{$name}": ["type:drupal-drush"],
"web/core": ["type:drupal-core"],
"web/modules/contrib/{$name}": ["type:drupal-module"],
"web/profiles/contrib/{$name}": ["type:drupal-profile"],
"web/themes/contrib/{$name}": ["type:drupal-theme"],
"web/libraries/{$name}": [
"docroot/core": ["type:drupal-core"],
"docroot/modules/contrib/{$name}": ["type:drupal-module"],
"docroot/profiles/contrib/{$name}": ["type:drupal-profile"],
"docroot/themes/contrib/{$name}": ["type:drupal-theme"],
"docroot/libraries/{$name}": [
"type:drupal-library",
"type:bower-asset",
"type:npm-asset",
Expand Down

0 comments on commit 51a057f

Please sign in to comment.