roots / docs Goto Github PK

Terms

• I have read the guidelines for Contributing to Roots Projects
• This request is not a duplicate of an existing issue
• I have read the docs and followed them (if applicable)
• I have seached the Roots Discourse for answers and followed them (if applicable)
• This is not a personal support request that should be posted on the Roots Discourse community

Description

What's wrong?

Unable to run Trellis on MacOS

What have you tried?

What insights have you gained?

The NFS mount type doesn't work by default on MacOS because of encrypted folders. That is in the docs but the solution is not.

Possible solutions

The solution is to change "vagrant_mount_type" in vagrant.default.yml file from "nfs" to "virtualbox" on MacOS. This should be mentioned in the docs.

Temporary workarounds

Steps To Reproduce

1. Use a MacOS machine with encrypted drive.
2. Try to install and run Trellis.

Expected Behavior

Works

Actual Behavior

Doesn't work

Relevant Log Output

No response

Versions

1.12.0

Sage 10's compiling assets docs need to be updated after replacing Mix with Bud

also https://docs.roots.io/acorn/2.x/use-in-sage/#asset-handling

On the User Contributed Extensions page are outdated and nonfunctional links:

• trellis-backup: Ansible Galaxy: Page not found
• trellis-cloudflare-origin-ca: Typist Blog: Page not found
• trellis-newrelic-php: Typist Blog: Page not found
• vagrant-trellis-cert: Typist Blog: Page not found
• cognomen has been abandoned and moved to trellis-cli.

Is trellis-cve-2018-6389 still needed for recent WordPress, would a note make sense that states for which WordPress versions this makes sense at all?

wp activate sage results in an error.

Error: Stylesheet is missing.

wp activate sage/resources results this issue.

Are there issues with define('WP_DEFAULT_THEME', 'sage') (or whatever the constant is) as well? This might resolve that as well.

x-ref: roots/sage#2030 | roots/sage-installer#3 | roots/sage#1938

Now that Trellis CLI is referenced throughout the Trellis docs, a section about Trellis CLI is called for.

• document replacing tailwind with bootstrap
• document removing tailwind

ref roots/bud#1142

using bud + bootstrap on a sage project

1. yarn add bootstrap --dev
2. yarn add @roots/bud-sass --dev
3. add import 'bootstrap'; to app.js
4. rename app.css to app.scss
5. add @import 'bootstrap/scss/...' lines to app.scss

A common confusion among users is that certain files aren't written to the filesystem during development.

We can help clarify things by explaining to users that webpack-dev-middleware uses an in-memory filesystem.

The webpack-dev-middleware is a small middleware for a connect-based middleware stack. It uses webpack to compile assets in-memory and serve them. When a compilation is running every request to the served webpack assets is blocked until we have a stable bundle.

https://webpack.github.io/docs/webpack-dev-middleware.html

We could maybe research a plugin that will write the in-memory filesystem to disk anyway, such as: https://github.com/gajus/write-file-webpack-plugin

we don't even talk about the ip_whitelist

Submit a feature request or bug report

• I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• This is a bug report
• This request isn't a duplicate of an existing issue

Replace any X with your information.

Suggestion for new/improved documentation

(delete this section if not applicable)

What is the URL for the current documentation (if applicable)?

https://roots.io/sage/docs/theme-installation/

How can the documentation be improved?

The command to install Sage from the documents at the above URL does not match the command in the README.md file at https://github.com/roots/sage/blob/master/README.md

The documentation url states the command as:

$ composer create-project roots/sage your-theme-name

Whereas the README.md file states the command as:

$ composer create-project roots/sage your-theme-name dev-master

Please note that the Sage Theme Book also lists the command on Page 20 as:

$ composer create-project roots/sage your-theme-name

How will this benefit users?

This creates an issue, as the documentation on the Sage 9 Packagist page at https://packagist.org/packages/roots/sage declares the minimum PHP version to be 7.0.x. Users may potentially install this version, which will work, but will have different minimum PHP requirements than the main documentation, which state >= 7.1.3. The two are not in sync with each other.

Also, the actual documentation on the site and in the book says to run the install command against the currently published version of the theme on Packagist. It is not generally a good idea to run installs against a "dev" branch unless you are intentionally doing so for development reasons. As such, all documentation should ideally reflect the current state of the requirements on the Packagist info page, not the documentation on a development branch. This is otherwise confusing to end users.

Is there a related Discourse thread (please link them)?

https://discourse.roots.io/t/discrepancies-when-installing-sage-vs-cloning-sage-from-official-repo/12156

Submit a feature request

• [X ] I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• This is a bug report
• This request isn't a duplicate of an existing issue

Hello !
I'm wandering what is the best way to load/include PHP files globally, like we would do including it in our functions.php file.
I thought that the composer.json:

"autoload": {
    "psr-4": {
      "App\\": "app/"
    }
  },

was enough to load all files within /app directory, but it's not. I see that default /app/*.php files are loaded by the array_map from function.php, wich have a hardcoded "../app/{$file}.php" pattern.

I finaly added to my composer.json

"autoload": {
    "psr-4": {
      "App\\": "app/"
    },
    "files": [
      "app/lib-autoload.php"
    ]
  },

with in lib-autoload.php a simple (but maybe not good?)

$files = glob(__DIR__ . '/lib/**/*.php');
if ($files === false) {
    throw new RuntimeException("Failed to glob for function files");
}
foreach ($files as $file) {
    require_once $file;
}
unset($file, $files);

To load all files from my /app/lib directory.

Is there any better/official way to load some files ?
I thought about placing them in controllers, but this is global like Taxonomy registration and stuff.
Those are not PHP Class, and not need to be namespaced (general filter/action mostly, helpers...).

Thanks a lot !

I'm trying to update wp from 4.7.0 to 4.7.3 according to the doc here -
https://github.com/roots/docs/blob/docs/bedrock/composer.md#updating-wp-and-plugin-versions

And I got the following output

Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 1 update, 0 removals

                                                 
  [InvalidArgumentException]                     
  Two packages cannot share the same directory!  
                                                 

update [--prefer-source] [--prefer-dist] [--dry-run] [--dev] [--no-dev] [--lock] [--no-custom-installers] [--no-autoloader] [--no-scripts] [--no-progress] [--no-suggest] [--with-dependencies] [-v|vv|vvv|--verbose] [-o|--optimize-autoloader] [-a|--classmap-authoritative] [--apcu-autoloader] [--ignore-platform-reqs] [--prefer-stable] [--prefer-lowest] [-i|--interactive] [--root-reqs] [--] [<packages>]...

add breadcrumbs to the top of each page so that it's obvious which project's docs you are viewing

See: roots/sage#1875

Solution appears to be: roots/sage#1875 (comment)

• I've read the guidelines for Contributing to Roots Projects
• This request isn't a duplicate of an existing request
• This is not a personal support request that should be posted on the Roots Discourse community

Summary

Because of some demand in the roots.io discourse (like https://discourse.roots.io/t/use-redis-cache-with-bedrock-and-trellis/15001/1) I wrote a little guide for setting up object caching (Redis) with Bedrock + Trellis:
https://gist.github.com/strarsis/95abe28f4761f489a8a1cc212d5c69e5
This is my first "real" technical guide, so there is probably some room for improvement.

Motivation

nginx microcaching already solves static page caching, but it isn't used for dynamic parts of the site.
Object caching can dramatically increase the performance here, as with WooCommerce and the admin backend.

the og:image for a doc should be https://cdn.roots.io/app/uploads/roots-og-updated.png by default, but the following should be used if applicable:

• https://cdn.roots.io/app/uploads/sage-og.png
• https://cdn.roots.io/app/uploads/bedrock-og.png
• https://cdn.roots.io/app/uploads/trellis-og.png
• https://cdn.roots.io/app/uploads/acorn-og.png
• https://cdn.roots.io/app/uploads/clover-og.png

Initial Acorn docs have been shipped 🎉 thanks to @alwaysblank @QWp6t @knowler via #314

Known additions that we want to get published:

• Installation: Configuration
• Basics: WP-CLI
• Basics: How can I use Acorn in my plugin?
  • Can I distribute a plugin uses Acorn? How does that work?
• Digging Deeper: Asset Management
  • Bundle
• Digging Deeper: Console
• Digging Deeper: Helpers
• Digging Deeper: Cache
• Digging Deeper: Collections
• Digging Deeper: Logging
• Digging Deeper: Filesystem
• Packages: Installing Packages
• Packages: Package Development
  • Mention extra.acorn.{providers,aliases} composer.json stuff
  • What is a service provider? How I make one?
  • How to provide a config file?
  • How to provide views? How to make those override-able?

Is this possible to install? Trellis that is, if I'm running a web admin like Plesk? I can proxy a subdomain with nginx to a different root location, that's nothing. But just wondering if all the other dependencies would work/conflict?

• I've read the guidelines for Contributing to Roots Projects
• This request isn't a duplicate of an existing issue
• I've read the docs and followed them (if applicable)
• This is not a personal support request that should be posted on the Roots Discourse community

Description

The documentation for Multisite alludes to a _sites.yml vars file which does not exist:

You'll also need to edit the _sites.yml vars file and update the multisite settings under your environment directory (group_vars/<environment>/wordpress_sites.yml):

https://github.com/roots/docs/blame/docs/trellis/multisite.md#L24

Additional information

I propose changing this line to:

You'll also need to update the multisite settings under your environment directory (group_vars/<environment>/wordpress_sites.yml):

• I've read the guidelines for Contributing to Roots Projects
• This request isn't a duplicate of an existing issue
• I've read the docs and followed them (if applicable)
• This is not a personal support request that should be posted on the Roots Discourse community

{{ site }} is rendered as empty <code></code> on https://roots.io/docs/trellis/master/deployments/#custom-tasks

Question: What is the correct syntax to display/escape {{ site }} on vuepress?

Submit a feature request or bug report

• I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• This is a bug report
• This request isn't a duplicate of an existing issue

Replace any X with your information.

Suggestion for new/improved documentation

What is the URL for the current documentation (if applicable)?

N/A

How can the documentation be improved?

It would be great to have an FAQ page in the docs for questions about theme and plugin compatibility and perhaps other questions people may have (i.e. shared hosting). This suggestion is specifically for Bedrock, but I guess Sage and Trellis could probably be benefited by FAQ pages as well.

How will this benefit users?

It will make this information more accessible to users and will save them from needing to scour Discourse for answers.

Is there a related Discourse thread (please link them)?

Not really. But questions like this.

the project sidebar should have some additional links at the bottom:

• link to github page for the project
• link to primary project page on roots.io
• link to the discourse category

Submit a feature request or bug report

• I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• This is a bug report
• This request isn't a duplicate of an existing issue

Replace any X with your information.

Suggestion for new/improved documentation

What is the URL for the current documentation (if applicable)?

https://roots.io/trellis/docs/local-development-setup/

How can the documentation be improved?

In step 3, "Run vagrant up.", please indicate that you need to navigate to the "trellis" subfolder first in the project directory. If you attempt to run "vagrant up" from any other directory, you receive the following error from Vagrant:

A Vagrant environment or target machine is required to run this
command. Run vagrant init to create a new Vagrant environment. Or,
get an ID of a target machine from vagrant global-status to run
this command on. A final option is to change to a directory with a
Vagrantfile and to try again.

How will this benefit users?

Easier for newbies to understand.

Is there a related Discourse thread (please link them)?

X

this one seems only work on the inline image, but not for the image on CSS.

https://github.com/roots/docs/blob/sage-9/sage/theme-development-and-building.md#images-in-template-files

• Use this one would have to run the rebuild commond to make the image to the DIST folder during the dev process if I am adding new images;
  <?php echo get_template_directory_uri() . '/dist/images/xxx.png';?>

• use this background-image: url(../images/xxx.png); seems not working on the Sage 9 because all the images are adding hash for reversion.

Submit a feature request or bug report

• I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• This is a bug report
• This request isn't a duplicate of an existing issue

ie
favicon https://www.npmjs.com/package/favicon
deployment https://www.npmjs.com/package/deployment
...

How can the documentation be improved?

some examples of how we now do this without grunt / gulp.

How will this benefit users?

I use a lot of 3rd party packages and there can be quite a lot to configure.

Submit a feature request or bug report

• I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• This is a bug report
• This request isn't a duplicate of an existing issue

Suggestion for new/improved documentation

So the recommended directly structure is this:

example.com/      # → Root folder for the project
├── trellis/      # → Your clone of this repository
└── site/         # → A Bedrock-based WordPress site
    └── web/
        ├── app/  # → WordPress content directory (themes, plugins, etc.)
        └── wp/   # → WordPress core (don't touch!)

From what I have read it seems that this (below) is the recommended what for multiple sites. Am I correct about that? I saw a thread dating back to 2015 on your discourse. And this question got asked often. So I suggest to document this so nobody asks it again. I admit I not really read all but ...

websites/      # → Root folder for the project
├── trellis/      # → Your clone of this repository
└── example.com/         # → A Bedrock-based WordPress site
    └── web/
        ├── app/  # → WordPress content directory (themes, plugins, etc.)
        └── wp/   # → WordPress core (don't touch!)
└── another-example.com/         # → A Bedrock-based WordPress site
    └── web/
        ├── app/  # → WordPress content directory (themes, plugins, etc.)
        └── wp/   # → WordPress core (don't touch!)

So if this is the recommended way then why is the root folder of the example structure called like a domain? I think its confusing because the wordpress-sites.yml also suggests that this is the way it should be done.

One could also do this. And then change the Vangrant box IP and have completely separate vagrant boxes? What are the benefits of this kind of setup? Or should that be avoided? Document this?

example.com/      # → Root folder for the project
├── trellis/      # → Your clone of this repository
└── site/         # → A Bedrock-based WordPress site
    └── web/
        ├── app/  # → WordPress content directory (themes, plugins, etc.)
        └── wp/   # → WordPress core (don't touch!)
another-example.com/      # → Root folder for the project
├── trellis/      # → Your clone of this repository
└── site/         # → A Bedrock-based WordPress site
    └── web/
        ├── app/  # → WordPress content directory (themes, plugins, etc.)
        └── wp/   # → WordPress core (don't touch!)

I think in general the docs are very basic. I already gave trellis a test spin but without my already pretty good Linux knowledge I would be lost I think.

Submit a feature request or bug report

• [ x] I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• [x ] This is a bug report
• This request isn't a duplicate of an existing issue

Bug report

(delete this section if not applicable)

Where is it?

https://github.com/roots/docs/blob/sage-9/sage/theme-configuration-and-setup.md

What should it say?

should css enqueue be:
wp_enqueue_style('sage/main.scss', asset_path('styles/main.scss'), false, null);

instead of how .css - how it's currently written?
wp_enqueue_style('sage/main.css', asset_path('styles/main.css'), false, null);

• I've read the guidelines for Contributing to Roots Projects
• This request isn't a duplicate of an existing issue
• I've read the docs and followed them (if applicable)
• This is not a personal support request that should be posted on the Roots Discourse community

Description

Building project with tailwind will not compile on yarn build. Resulting error is:

Module build failed: ModuleBuildError: Module build failed: ValidationError: Invalid options object. PostCSS Loader has been initialized using an options object that does not match the API schema.
 - options has an unknown property 'plugins'. These properties are valid:
   object { postcssOptions?, execute?, sourceMap? }

Seems to be related to PostCSS compatibility in the dependencies. Possible solution offered by downgrading the postcss-loader version outlined here laravel-mix/laravel-mix#2471

Steps to reproduce

1. composer create-project roots/sage theme-name + complete CLI steps
2. select Tailwind CSS (option 5) on the last steps
3. yarn && yarn build

Expected behavior:
A successful build...

Actual behavior:
The error outlined above.. traced to main.scss compilation

How would I go about referencing an asset like this?

	selector.css('background-image', 'url(' + general.theme_file_uri + '/dist/images/flags/48/' + region.toLowerCase() + '.svg' + ')');

It won't work once I build to production

Mac OS basic setup page.

Install Cask:

$ brew tap caskroom/cask

https://stackoverflow.com/a/58337898/2986401
You don't need to install cask anymore, you just need homebrew.

Would it be considered bad practice to include the filter inline with a template?

add_filter( 'sage/display_sidebar', '__return_false' );

For instance adding this at the top of a template should allow disabling of the sidebar for that template, allowing for localized control, so you don't have to dig around to find the filter that controls it for a certain template, or deal with conditionals to specifically target the template your already editing.

Just thought that may be useful in the documentation.

• [x ] I've read the guidelines for Contributing to Roots Projects
• [ x] This request isn't a duplicate of an existing request
• [ ]x This is not a personal support request that should be posted on the Roots Discourse community

Summary

Would love it if y'all added a line to the docs showing how to add multiple mu-plugins here:

https://roots.io/docs/bedrock/master/composer/#force-plugin-to-be-mu-plugin

Took lonoger than it should have to dig it up from this github issue:

roots/bedrock#132 (comment)

Motivation

This will help people with using bedrock.

I think it would be nice if the docs mentioned on installing-trellis that the project directory must not be in an ecryptfs directory.

ecryptfs is used if the "encrypt my home folder" option is selected during a Ubuntu install. In that case, any directory outside /home should work.

See more info at roots/trellis#738

Submit a feature request or bug report

• I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• This is a bug report
• This request isn't a duplicate of an existing issue

Where is it?

https://github.com/roots/docs/blob/docs/trellis/ssl.md
#L209

What should it say?

HSTS Preloading is a mechanism whereby a list of hosts that wish to enforce the use of SSL/TLS on their site is built into a browser. This list is compiled by Google and is utilised by Chrome, Firefox, Opera, Safari, IE11 and Edge. These sites do not depend on the issuing of the HSTS response header to enforce the policy, instead the browser is aleady aware that the host requires the use of SSL/TLS before any connection or communication even takes place. This removes the opportunity an attacker has to intercept and tamper with redirects that take place over HTTP. This isn't to say that the host needs to stop issuing the HSTS response header, this must be left in place for those browsers that don't use preloaded HSTS lists.

To ckeck the actual list:

Most major browsers (Chrome, Firefox, Opera, Safari, IE 11 and Edge) also have HSTS preload lists based on the Chrome list. (See the HSTS compatibility matrix.)

https://hstspreload.org/

explain why you might need to set it to false

Some genius wrote this:

The correct way to resolve this is to set your local_path in your wordpress_sites.yml file.

https://github.com/roots/trellis/blob/master/group_vars/production/wordpress_sites.yml#L11

I'm guessing that it's currently ../site, which is resolving to /vagrant/../site, which is /site, which doesn't exist. You should change that to something like /srv/www/example.com/current.

Alternatively, you can move your Vagrantfile one level up so that it sits alongside your trellis and site folders. This is how we used to do it in roots-example-project. Just make sure to change your ANSIBLE_PATH in Vagrantfile to something like File.join(__dir__, 'trellis') [ref]. This will put your site files in /vagrant/site and your trellis stuff in /vagrant/trellis. Now local_path: ../site will resolve to /vagrant/trellis/../site, which is /vagrant/site, which exists.

https://discourse.roots.io/t/trellis-bedrock-sage-on-windows-issue-with-build-before-yml/7825/6

The latter suggestion of moving Vagrantfile up one level has the added benefit of making the settings work cross-platform.

Submit a feature request or bug report

• I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• This is a bug report
• This request isn't a duplicate of an existing issue

Replace any X with your information.

Suggestion for new/improved documentation

(delete this section if not applicable)

What is the URL for the current documentation (if applicable)?

https://github.com/roots/docs/blob/docs/sage/theme-configuration-and-setup.md

How can the documentation be improved?

Minor issue, it's still referring to src/setup.php instead of app/setup.php

How will this benefit users?

Won't confuse newbies.

Submit a feature request or bug report

• I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• This is a bug report
• This request isn't a duplicate of an existing issue

Replace any X with your information.

Suggestion for new/improved documentation

(delete this section if not applicable)

What is the URL for the current documentation (if applicable)?

https://roots.io/trellis/docs/multisite/

How can the documentation be improved?

You have this documentation:

You'll also need to define the env dictionary for multisite installs with these three settings:

env:
  domain_current_site: example.com
  wp_home: http://example.com
  wp_siteurl: http://example.com/wp

where does this get updated? is it /trellis/group_vars/all/helpers.yml? should that be updated to:

wordpress_env_defaults:
  db_host: localhost
  db_name: "{{ item.key | underscore }}_{{ env }}"
  db_user: "{{ item.key | underscore }}"
  disable_wp_cron: true
  wp_env: "{{ env }}"
  wp_home: "{{ ssl_enabled | ternary('https', 'http') }}://{{ site_hosts_canonical | first }}"
  wp_siteurl: "{{ ssl_enabled | ternary('https', 'http') }}://{{ site_hosts_canonical | first }}/wp"
  domain_current_site: "{{ site_hosts_canonical | first }}"

How will this benefit users?

Helpful for getting started!

Is there a related Discourse thread (please link them)?

https://discourse.roots.io/t/multisite-which-what-env-dictionary-to-update/8420

• I've read the guidelines for Contributing to Roots Projects
• This request isn't a duplicate of an existing issue
• I've read the docs and followed them (if applicable)
• This is not a personal support request that should be posted on the Roots Discourse community

Description

Related to this discussion: https://discourse.roots.io/t/sage-10-as-parent-child-themes/
It would be fantastic to get some feedback ftom @Log1x and @QWp6t

Steps to reproduce

1. Parent Theme:

1.1 Make a new Sage 10 Theme with custom Namespace "Parent" in folder 'parent'
1.2 Add some View Composers variables such as "siteName" and reference it in a blade file
1.3 Add a function my_test_function() to helpers.php
1.4 Activate the theme, it should be working and the variable $siteName is outputted correctly

2. Child Theme

1.1 Make a new Sage 10 Theme and leave the Namespace as "App" in folder child
1.2 Add Template: parent to style.css
1.3 Remove all blade files from ./resources/views/
1.4 Use \Parent\my_test_function() e.g. in a child View Composer
1.5 Autoload parent theme Class in composer.php:

"psr-4": {
      "App\\": "app/",
      "Parent\\": "./../parent/app/"
    }

1.5 Activate the child theme

Expected behavior: [What you expect to happen]

• Blade views are loaded from parent theme
• View Composers are loaded from parent theme as well as from child theme (ideally overwriting parent values)
• Functions from parent theme in helpers.php are available via \Parent\my_test_function()
• Config via \Roots\config() is loading parent theme value, if child theme value is not set

Actual behavior: [What actually happens]

• Blade views are loaded from parent theme
• Undefined variable: siteName errors, the View Composers from the parent theme are missing
• Call to undefined function errors when calling \Parent\my_test_function()
• Error if e.g. \Roots\config('app.debug') is not set in child theme as function not checks against parent value

Reproduces how often: [What percentage of the time does it reproduce?]

In the current setup 100%. More tests required.

Versions

Sage 10.0.0-alpha

Additional information

It would be fantastic to get a very short summary how child/parent themes should be set-up with Sage 10.

Installing Trellis

Think this can be improved? Please open a thread on our Discourse or contribute on GitHub.

Of course. How about a Roots CLI?

One could just type roots install. A bash script could ask what to use (Trellis, Bedrock, Sage) and which project/directory name to use. After that all installation will be done automatically. A CLI could be useful for more installation magic like configuration of Bedrock and Sage, etc.

Submit a feature request or bug report

• I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• This is a bug report
• This request isn't a duplicate of an existing issue

Replace any X with your information.

Suggestion for new/improved documentation

(delete this section if not applicable)

What is the URL for the current documentation (if applicable)?

https://roots.io/sage/docs/theme-configuration-and-setup/
https://roots.io/sage/docs/blade-templates/

How can the documentation be improved?

Currently the soberwp/controller package is included with Sage 9. However, recent updates to Controller have broken functionality with regards to how filters are supposed to work in the Sage 9 documentation for passing data to templates (see https://roots.io/sage/docs/blade-templates/).

Through various discussions, it has been mentioned that soberwp/controller is an optional part of Sage 9. However, the documentation does not currently make this clear, or offer instructions on how to remove soberwp/controller should the user not desire to utilize it.

Furthermore, filters are promoted as the proper way to do data passing to templates in Sage 9, but they do not work as of this writing (see soberwp/controller#80) due to conflicts with soberwp/controller.

The documentation should be altered to clarify that soberwp/controller is optional, and can be removed by altering composer.json and running composer update && composer dump-autoload.

How will this benefit users?

Clarity in the usage of soberwp/controller and its optional use in Sage 9, as well as instructions on removing it if it is not desired in a base install.

Is there a related Discourse thread (please link them)?

https://discourse.roots.io/t/sage-9-passing-acf-data-via-blade-not-working/11641/
https://discourse.roots.io/t/passing-data-between-filters-and-templates-not-working/12718/
https://discourse.roots.io/t/using-controllers-or-filters-to-output-custom-fields/11812/

Is possible to remove /wp from SITE_URL

• I've read the guidelines for Contributing to Roots Projects
• This request isn't a duplicate of an existing request
• This is not a personal support request that should be posted on the Roots Discourse community

Summary

One paragraph explanation of the feature.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

Additional context

Add any other context or screenshots about the feature request here.

After introducing Sage 10 docs, some searches will result in showing both Sage 9 and Sage 10 documentation:

Potential solutions

• Add visual indicator for 9.x vs 10.x on results
• Limit search queries to the current project
  • This might require UI updates to help make it clear what is currently being searched for

• I've read the guidelines for Contributing to Roots Projects
• This request isn't a duplicate of an existing request
• This is not a personal support request that should be posted on the Roots Discourse community

Summary

Update the Roots Trellis documentation to include a section on the new HTTP composer authentication method added in roots/trellis#1091

Motivation

roots/trellis#1091 added support for HTTP basic authentication for multiple composer repositories. I would like to contribute a section in the docs to reflect this, with examples (eg https://discourse.roots.io/t/gitlab-private-repo-as-composer-package/20592/19). I'm in charge of the technical documentation at Delicious Brains, and I'm updating our plugin composer documentation to point folks to this new method. It makes sense to also help update the official docs, to be able to add a link to them.

Submit a feature request or bug report

• I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• This is a bug report
• This request isn't a duplicate of an existing issue

Suggestion for new/improved documentation

What is the URL for the current documentation (if applicable)?

https://roots.io/sage/docs/theme-development-and-building/

How can the documentation be improved?

A note should be added about increasing Browsersync’s delay to help account for file syncing (Trellis/Vagrant).

https://github.com/roots/sage/blob/master/resources/assets/build/webpack.config.watch.js#L34

How will this benefit users?

This will help mitigate a reoccurring question on Discourse and in other places.

Is there a related Discourse thread (please link them)?

https://discourse.roots.io/t/sage-9-browsersync-not-updating-right/10648/9

I’m putting this here as a note for myself make a PR when I have the time — perhaps later today — but if I never get to it, feel free to make a PR/update it.

Is it safe to have an .env file?

Submit a feature request or bug report

• I've read the guidelines for Contributing to Roots Projects
• This is a suggestion for new documentation
• This is a suggestion for improving the current documentation
• This is a bug report
• This request isn't a duplicate of an existing issue

Replace any X with your information.

Suggestion for new/improved documentation

Old Sage 8.5.1 Theme Structure is shown at https://github.com/roots/docs/blob/sage-9/sage/theme-configuration-and-setup.md#theme-structure

This needs to be updated to latest one of Sage 9 as a lot of things have moved.
What is the URL for the current documentation (if applicable)?

https://github.com/roots/docs/blob/sage-9/sage/theme-configuration-and-setup.md#theme-structure

How can the documentation be improved?

Update Theme Structure to Sage 9.

How will this benefit users?

Reduces confusion about where to find relevant stuff especially who's just starting with new Sage 9.

Is there a related Discourse thread (please link them)?

X

ansible-playbook deploy.yml -vvvv -e "site= env=

to:

ansible-playbook deploy.yml -vvvv -e "site= env="