altis-cms icon indicating copy to clipboard operation
altis-cms copied to clipboard

Document available configuration

Open rmccue opened this issue 5 years ago • 5 comments

Version 2.0 disabled emoji by default with #83, but we never documented it. There's other options we haven't documented properly, so we should document all of these.


Acceptance criteria:

  • [ ] All settings in load.php are documented in the README.md or relevant docs pages

rmccue avatar Sep 10 '19 09:09 rmccue

Are the options you're referring to the the ones in load.php?

	$default_settings = [
		'enabled'       => true,
		'branding'      => true,
		'login-logo'    => '/vendor/altis/cms/assets/logo.svg',
		'shared-blocks' => true,
		'default-theme' => 'base',
		'remove-emoji'  => true,
		'xmlrpc'        => true,
	];

Where exactly would these be documented?

sambulance avatar Jan 08 '20 10:01 sambulance

Each module has it's own docs, e.g. https://github.com/humanmade/altis-cms/tree/master/docs. You can view them locally in the admin-bar Altis Logo -> Documentation.

Yes those are the options!

joehoyle avatar Jan 08 '20 10:01 joehoyle

In addition, there are a few third-party plugins added to the CMS module that are not documented.

https://github.com/humanmade/altis-cms/blob/master/composer.json#L13

  • "stuttter/wp-user-signups"
  • "roots/wp-password-bcrypt"
  • "johnbillion/extended-cpts"

sambulance avatar Jan 16 '20 19:01 sambulance

  • "johnbillion/extended-cpts"

extended-cpts has documentation now 👍

https://github.com/humanmade/altis-cms/blob/master/docs/extended-cpts.md

kevinlangleyjr avatar Jan 21 '20 23:01 kevinlangleyjr

Blocked by https://github.com/humanmade/altis-cms/issues/260

jennybeaumont avatar Oct 13 '20 14:10 jennybeaumont