automattic / vip-go-skeleton Goto Github PK

The base repository structure for all VIP Go sites

Home Page: https://docs.wpvip.com/technical-references/vip-platform/

CSS 2.20% PHP 86.97% HTML 10.74% Shell 0.09%

vip-go-skeleton's Introduction

WordPress VIP Skeleton Application

Welcome to WordPress VIP! This repository is a starting point for building your WordPress VIP application, including all the base directories.

Guidebooks

We recommend starting with one of the following WordPress VIP guidebooks:

Directories

All the following directories are required and must not be removed:

client-mu-plugins/: For always active global plugins (similar to mu-plugins).
docs/: Not mounted to production, so useful for storing documentation about an applications features and requirements.
images/: Store your site's favicons here. All other public-facing images should be uploaded or imported to the WordPress dashboard or stored as part of your /theme/ assets.
languages/: For .po and .mo translation files, which specify the translated strings for the site.
plugins/: Your site's regular plugins.
private/: Provides access to files that are not directly web accessible, but can be accessed by your theme or plugin code.
themes/: Themes available to your sites. We recommend keeping the default theme available for testing purposes.
vip-config/: For custom configurations and additional sunrise.php changes. This folder’s vip-config.php can be used to supply things usually found in wp-config.php..

These directories will also be available on production web servers. Any additional directories created in your GitHub repository that are not included in the above list will not be mounted onto your site, and so will not be web-accessible.

For more information on how our codebase is structured, see https://docs.wpvip.com/technical-references/vip-codebase/.

The docs/ directory is a special directory that contains your documentation for your application. It is not mounted onto your site, but is available for you to use. See docs/index.php for more information.

PHPCS for checking coding standards

This repo contains a starting point for installing and using a local version of PHP_CodeSniffer (PHPCS). To get started, you'll need to have Composer installed, then open a command line at this directory, and run:

composer install

This will install PHPCS and register the below standards:

The .phpcs.xml.dist file contains a suggested configuration, but you are free to amend this. You can also extend it for more granularity of configuration for theme and custom plugins.

To run PHPCS, navigate to the directory where the relevant .phpcs.xml.dist lives, and type:

vendor/bin/phpcs

See the PHPCS documentation (or run phpcs -h) for the available command line arguments.

Support

If you need help with anything, VIP's support team is just a ticket away.

Your documentation here

Feel free to add to or replace this README.md content with content unique to your project, for example:

Project-specific notes; like a list of VIP environments and branches,
Workflow documentation; so everyone working in this repo can follow a defined process, or
Instructions for testing new features.

This can be detailed in the docs/ directory.

vip-go-skeleton's People

Contributors

Stargazers

Watchers

vip-go-skeleton's Issues

Remove images directory

This should not be used as a matter of course, instead sites should utilise the media library

Why is plugins/user-switching in the .gitignore file?

Could someone speak to this one? I can see that query-monitor is here because it is already in the /wp-content/mu-plugins folder, but user-switching, log-deprecated-notices, and monster-widget are not. For my own purposes, I was trying to add user-switching to my repo.

Will there be problems if I remove this from my own repo's .gitignore file?

Include deployment tooling and local development environment

The current skeleton repository leaves a lot of questions unanswered, for example:

How to create a standardised local development environment that matches the VIP Go setup without everyone on the team doing it manually.
How to include built JS/CSS files or PHP libraries that are normally excluded from Git tracking?
How to deploy changes to VIP Go staging and production environment, preferably automatically after merging to develop or master?

We've created this VIP Go project template which includes tooling for deploys, managing dependencies and also a local development environment.

Would any of that be useful for this default project skeleton?

Issue with MySQL on M1 Mac

When I start the docker instance using the docker-compose up --detach --remove-orphans --build command, I get this error:

ERROR: no matching manifest for linux/arm64/v8 in the manifest list entries```

This is due to an issue with MySQL not being supported on M1 processors by default.

Update TwentySeventeen

The currently included version of TwentySeventeen is 1.3, but the current released version is 1.7.

Can this be a straight swap?

remove Hello Dolly

No VIPv2 customer is going to want this in there. :)

Have a default .deployignore file

Suggestion to add a .deployignore file that contains a few default typical files such as phpcs.xml.dist variants, or directories like tests/.

Not only would this encourage better awareness of this supported feature, it would act as a real example, as well as reducing the amount of typical items that would be pushed to production sites.

With comments in it, and a reference to our fuller documentation, it would be easy for client developers to amend, or simply delete if they didn't need it.

Add sample .vip.yml

What do you think of the idea of adding a sample config/.vip.yml config file for domain mapping? It could help clarify the syntax required.

https://vip.wordpress.com/documentation/vip-go/syncing-data-on-vip-go/#domain-mapping-config

I was thinking the code could be commented out. Would it screw anything up with the sync process, however, if the sync finds the file and there's nothing in it?

If you like this idea, I'll create a PR.

Fix Incorrect wording Change `true` to `false` on vip-go-skeleton/blob/master/vip-config/vip-config.php#L36

According to our documentation here:

https://docs.wpvip.com/technical-references/restricting-site-access/controlling-content-distribution-via-jetpack/#h-enabling-content-distribution

This line should read You can disable "private" mode (e.g. for testing) in non-production environment by setting the constant to false below (or just by removing the lines).

Currently it says to set the constant to true

https://github.com/Automattic/vip-go-skeleton/blob/master/vip-config/vip-config.php#L36

This has caused some confusion with a customer in 152061-zen