initial commit of drupal doc for upsun #4382
Conversation
|
Your Platform.sh environment has successfully deployed. 🚀 See the changed pages: Platform.sh docs |
| redis: 'cache:redis' | ||
| mounts: | ||
| # The default Drupal files directory. | ||
| '/web/sites/default/files': |
There was a problem hiding this comment.
@gilzow maybe writing mounts in a shorten version could help readability?
mounts:
# The default Drupal files directory.
'/web/sites/default/files': { source: storage, source_path: 'files' }
# Drupal gets its own dedicated tmp directory. The settings.platformsh.php
# file will automatically configure Drupal to use this directory.
'/tmp': { source: storage, source_path: 'tmp' }
# Private file uploads are stored outside the web root. The settings.platformsh.php
# file will automatically configure Drupal to use this directory.
'/private': { source: storage, source_path: 'private' }
# Drush needs a scratch space for its own caches.
'/.drush': { source: storage, source_path: 'drush' }
# Drush will try to save backups to this directory, so it must be
# writeable even though you will almost never need to use it.
'/drush-backups': { source: storage, source_path: 'drush-backups' }
There was a problem hiding this comment.
I think the longer format, while it does increase the page length, is easier to read. @Kemi-Elizabeth do you have any insight/input?
There was a problem hiding this comment.
When you say shortened version, do you mean without the comments? I found it quite easy to read but I was taking my time. I understand that it might not be scannable, but do we want this to be easily scannable? I would think that people taking the time to read this article would want to take in all the details even if it makes the page a bit longer?
| start: 'cd web ; drush core-cron' | ||
| runtime: | ||
| # Enable the redis extension so Drupal can communicate with the Redis cache. | ||
| extensions: |
There was a problem hiding this comment.
extensions: { redis, sodium, apcu, blackfire }
?
| # | ||
| # We don't want to run drush commands if drupal isn't installed. | ||
| # Similarly, we don't want to attempt to run config-import if there aren't any config files to import | ||
|
|
There was a problem hiding this comment.
I've tried to remove all uses of first person plural and tried to tone down the conversational TOV so that it fits more with the formality of the Docs as opposed to the DevCenter articles. I did see that some of the comments within the code are a bit colloquial (ie. the one above uses a tone that could come across slightly conversational). Do we want to keep those as they are (I'm not sure if changing the comments might affect the code snippet example)? @gilzow
There was a problem hiding this comment.
@Kemi-Elizabeth i think the comments are important so the reader know what the commands are doing. We could change it to be:
# Don't run drush commands if drupal isn't installed.
# Don't run config-import if there aren't any config files to import
?
There was a problem hiding this comment.
Perfect! Yes, I still think the comments are necessary, I just wasn't sure if we could change the wording. But that's perfect and definitely along the lines of what I was thinking.
Added kemi's suggestions Co-authored-by: Kemi Elizabeth <[email protected]>
Co-authored-by: Kemi Elizabeth <[email protected]>
Why
Closes #4381
What's changed
Adds Drupal Guide to Upsun docs
Where are changes
Updates are for:
sites/platformtemplates)sites/upsuntemplates)