Issue #1092: Docs makeover #1088

oxyc · 2016-12-29T19:21:46Z

I'm just toying around with a new docs TOC. I feel it's getting a bit chaotic... Not sure how to section it though... Thoughts? Is it needed or no? I also added numbering to the TOC (omg readthedocs has a lot of bugs).

oxyc · 2016-12-29T19:29:44Z

If interested, maybe we can try and define the docs outline in an issue.

geerlingguy · 2016-12-29T22:13:47Z

Let's do that—rather than jump around a bit in RTD. I do think we could organize docs better... and RTD does get quite annoying—but it's free, connected to GitHub, searchable (thanks to your help), etc. so it's the best of what we have available for zero maintenance cost :)

You know that of course, but just documenting my reasons for still using it.

oxyc · 2017-01-18T01:15:25Z

Still WIP and needs work. I just need to go do something else after staring at this for too long. I'll continue tomorrow.

Sorry about the massive commit, energy ran out and I just wanted to push something. If you prefer I can try and split it into parts.

Let me know what you think, I don't mind re-structuring.

Edit: Oh and I reverted the numbering, it was buggy... default is probably good enough

oxyc · 2017-01-18T01:18:44Z

docs/other/performance.md

@@ -0,0 +1,11 @@
+## Improving composer build performance


I added this section because

I split the composer deployment setups into separate pages and linked both to this page.

Thought we might extend it in the future.

Might be other performance related stuff in the docs that could be moved here also. I'll have a look tomorrow.

Yeah, it would be good to also at least point people to notes on Windows performance, NFS/rsync/native share performance, how to adjust memory limits (for VM and php especially), etc. Also, cachier, things like that. Simple is best, but anything that people might not ordinarily know about would be good to document.

I'll move those sections here too. Cleans up the windows installation section which is a bit too crowded at the moment.

I moved a couple of scattered performance sections here instead.

oxyc · 2017-01-18T01:22:32Z

docs/extras/adminer.md

@@ -0,0 +1,3 @@
+If you have `adminer` listed as one of the `installed_extras` inside `config.yml`, you can use Adminer's web-based interface to interact with databases. With Drupal VM running, visit [http://adminer.drupalvm.dev/](http://adminer.drupalvm.dev/), and log in with `drupal` as the username and the password you set in `config.yml` (`drupal_db_password`). Leave the "Server" field blank. The "Database" field is optional.


This is a duplicate with Connect to the MySQL database, but i feel the paragraph isnt long enough to justify a reference, and I do think it's important it's mentioned in both places.

Sounds reasonable.

oxyc · 2017-01-18T01:23:15Z

docs/extras/memcached.md

+
+```php
+// Make memcache the default cache class.
+$settings['cache']['default'] = 'cache.backend.memcache';


I haven't actually tested this in a while, but I'm pretty sure this is how it was supposed to be configured..

I think this is correct. The README for the 8.x-2.x branch is still a bit outdated for some reason.

I verified that both this and the redis docs work.

oxyc · 2017-01-18T01:23:45Z

docs/extras/redis.md

@@ -0,0 +1,5 @@
+[Redis](https://redis.io/) is an in-memory caching system, much like [Memcached](memcached.md). While [Varnish](varnish.md) is generally used to improve performance for anonymous users, `redis` is used to improve the performance for logged in users.
+
+To enable Redis in Drupal VM, first make sure `redis` is in the list of `installed_extras` in your `config.yml`. Install the [Redis](https://www.drupal.org/project/redis) module and configure it as described in the [module's README](http://cgit.drupalcode.org/redis/tree/README.md).


I felt something is better than nothing. But would be great if we could elaborate on this.

I haven't done much Redis testing in the past 6 months. I'm fine with this as-is, and we can update it once someone actually starts playing around with Redis some more :D

I plan to test this and memcached to make sure we have some basic docs. Not sure I'll have time to fix everything until the weekend though.

As always, you're awesome! I'll hold off on the merge, then—unless you want me to merge now, then we can just review the changes/cleanups in a follow-up PR. I'd like to tag a new release soon, since there are a few small bugs fixed.

Mind holding off or tagging a new release without this? I'd like to read through everything at least once more.

oxyc · 2017-01-18T01:24:43Z

docs/extras/tideways.md

+
+To enable profiling of Drupal pages using the Tideways PHP Extension, follow the directions for [configuring the XHProf and the XHProf module](xhprof.md#xhprof-module), but choose the _Tideways_ extension under in the _Profiling settings_ section.
+
+As with the XHProf extension, you can view callgraphs (and a listing of all stored runs) using Drupal VM's own XHProf UI installation by visiting [http://xhprof.drupalvm.dev/](http://xhprof.drupalvm.dev) and clicking on the relevant run, then clicking the _[View Full Callgraph]_ link.


@geerlingguy I added a note on the XHProf UI working with Tideways as well.

oxyc · 2017-01-18T01:28:54Z

mkdocs.yml

+ - 'upload-progress': 'extras/upload-progress.md'
+ - 'varnish <small>(Caching reverse proxy)</small>': 'extras/varnish.md'
+ - 'xdebug <small>(Debugging tool)</small>': 'extras/xdebug.md'
+ - 'xhprof <small>(Profiling tool)</small>': 'extras/xhprof.md'


Personal styling preference, this makes the name stand out while still explaining what it is.

I'm fine with that, as long as RTD isn't barfing on it.

oxyc · 2017-01-18T01:29:16Z

mkdocs.yml

+ - 'mailhog <small>(Mail catcher)</small>': 'extras/mailhog.md'
+ - 'memcached <small>(In-memory cache)</small>': 'extras/memcached.md'
+ - 'newrelic <small>(Performance monitoring)</small>': 'extras/newrelic.md'
+ - 'nodejs': 'extras/nodejs.md'


Couldn't come up with a short description for java, nodejs, ruby or upload-progress :D

No big deal... they're pretty self-explanatory (IMO).

geerlingguy · 2017-01-19T20:41:46Z

Sure; we can do a bugfix release, then next tag could be docs release :)

oxyc · 2017-01-26T14:53:09Z

I'm sure there are more typos and grammar errors... But I've read through everything at least 3 times now.

oxyc · 2017-01-26T15:10:34Z

docs/extras/drush.md

+drupalvm_cron_jobs:
+ - name: "Drupal Cron"
+ minute: "*/30"
+ job: "{{ drush_path }} -r {{ drupal_core_path }} core-cron"


Also fixes #1027

geerlingguy · 2017-01-26T15:34:53Z

Let's do it!

oxyc changed the title ~~[WIP] Docs makeover~~ [WIP] Issue #1092 :Docs makeover Dec 29, 2016

oxyc force-pushed the docs-makeover branch from 348dd04 to e3e7246 Compare January 18, 2017 01:14

oxyc changed the title ~~[WIP] Issue #1092 :Docs makeover~~ [WIP] Issue #1092: Docs makeover Jan 18, 2017

oxyc force-pushed the docs-makeover branch from e3e7246 to d48c08a Compare January 18, 2017 01:17

oxyc commented Jan 18, 2017

View reviewed changes

oxyc force-pushed the docs-makeover branch from bac5ea9 to fae8fcb Compare January 18, 2017 03:09

oxyc force-pushed the docs-makeover branch from fae8fcb to 9fa6048 Compare January 26, 2017 14:48

oxyc added 7 commits January 26, 2017 09:49

Change all the docs!

4e17569

cleanup [ci skip]

d04f767

Move windows synced folder options to performance section [ci skip]

a4f9706

Update index.md with new getting started pages [ci skip]

c37b740

Fix typos etc [ci skip]

742b763

Move synced folder performance to performance section [ci skip]

89a1e69

update redis docs with instructions [ci skip]

0856af0

oxyc force-pushed the docs-makeover branch from 9fa6048 to 0856af0 Compare January 26, 2017 14:50

oxyc changed the title ~~[WIP] Issue #1092: Docs makeover~~ Issue #1092: Docs makeover Jan 26, 2017

Issue geerlingguy#1110: Move cron example to docs [ci skip]

25acaf5

oxyc force-pushed the docs-makeover branch from 3ee1e27 to 25acaf5 Compare January 26, 2017 15:09

oxyc commented Jan 26, 2017

View reviewed changes

geerlingguy merged commit 3566b31 into geerlingguy:master Jan 26, 2017

oxyc deleted the docs-makeover branch April 24, 2017 15:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Issue #1092: Docs makeover #1088

Issue #1092: Docs makeover #1088

Uh oh!

oxyc commented Dec 29, 2016 •

edited

Loading

oxyc commented Dec 29, 2016

geerlingguy commented Dec 29, 2016

oxyc commented Jan 18, 2017 •

edited

Loading

oxyc Jan 18, 2017 •

edited

Loading

geerlingguy Jan 19, 2017

oxyc Jan 19, 2017

oxyc Jan 26, 2017

oxyc Jan 18, 2017

geerlingguy Jan 19, 2017

oxyc Jan 18, 2017

geerlingguy Jan 19, 2017

oxyc Jan 26, 2017

oxyc Jan 18, 2017

geerlingguy Jan 19, 2017

oxyc Jan 19, 2017

geerlingguy Jan 19, 2017

oxyc Jan 19, 2017

oxyc Jan 18, 2017

oxyc Jan 18, 2017

geerlingguy Jan 19, 2017

oxyc Jan 18, 2017

geerlingguy Jan 19, 2017

geerlingguy commented Jan 19, 2017

oxyc commented Jan 26, 2017

oxyc Jan 26, 2017

geerlingguy commented Jan 26, 2017

Labels

2 participants

		@@ -0,0 +1,3 @@
		If you have `adminer` listed as one of the `installed_extras` inside `config.yml`, you can use Adminer's web-based interface to interact with databases. With Drupal VM running, visit [http://adminer.drupalvm.dev/](http://adminer.drupalvm.dev/), and log in with `drupal` as the username and the password you set in `config.yml` (`drupal_db_password`). Leave the "Server" field blank. The "Database" field is optional.

		@@ -0,0 +1,5 @@
		[Redis](https://redis.io/) is an in-memory caching system, much like [Memcached](memcached.md). While [Varnish](varnish.md) is generally used to improve performance for anonymous users, `redis` is used to improve the performance for logged in users.

		To enable Redis in Drupal VM, first make sure `redis` is in the list of `installed_extras` in your `config.yml`. Install the [Redis](https://www.drupal.org/project/redis) module and configure it as described in the [module's README](http://cgit.drupalcode.org/redis/tree/README.md).


		To enable profiling of Drupal pages using the Tideways PHP Extension, follow the directions for [configuring the XHProf and the XHProf module](xhprof.md#xhprof-module), but choose the _Tideways_ extension under in the _Profiling settings_ section.

		As with the XHProf extension, you can view callgraphs (and a listing of all stored runs) using Drupal VM's own XHProf UI installation by visiting [http://xhprof.drupalvm.dev/](http://xhprof.drupalvm.dev) and clicking on the relevant run, then clicking the _[View Full Callgraph]_ link.

Uh oh!

Issue #1092: Docs makeover #1088

Issue #1092: Docs makeover #1088

Uh oh!

Conversation

oxyc commented Dec 29, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

oxyc commented Dec 29, 2016

geerlingguy commented Dec 29, 2016

oxyc commented Jan 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

oxyc Jan 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

geerlingguy commented Jan 19, 2017

oxyc commented Jan 26, 2017

Choose a reason for hiding this comment

geerlingguy commented Jan 26, 2017

Labels

2 participants

oxyc commented Dec 29, 2016 •

edited

Loading

oxyc commented Jan 18, 2017 •

edited

Loading

oxyc Jan 18, 2017 •

edited

Loading