search

contentacms / contenta_jsonapi

Contenta CMS, the decoupled Drupal
http://www.contentacms.org/
GNU General Public License v2.0
328 stars 104 forks source link

Install docs #366

Closed GMSteuart closed 4 months ago

GMSteuart commented 5 years ago
e0ipso commented 5 years ago

Thanks for this @GMSteuart. We are trying to centralize all the installation documentation under http://www.contentacms.org/#install.

Do you think there is anything missing there? If so, please submit the PR against https://github.com/contentacms/contentacms.github.io so it shows up there.

GMSteuart commented 5 years ago

@e0ipso the readme docs ultimately get published to the documentation right?

After looking over the docs, there are only a few install stuff I would probably add, and then a few things in the project codebase I would change:

1) I consider the current default install a demo install. I understand this intended to get people up and running quickly with what ContentaCMS has to offer, but as a developer I would imagine that the default installation gives me the foundation for making a ContentaCMS project; not a demo project. My recommendation would be to update the installers so that there is:

Possible Solutions:

2) Add that PHP is a requirement above composer. I understand that its typically assumed that PHP is installed, but this is also an opportunity for the ContentaCMS team to set the minimum PHP requirement desired for the ContentaCMS contributions moving forward. Currently, I believe it is set by drupal-scaffold with ^5.5.9|>=7.0.8.

3) In the Quick Installation section, link the text See get composer for more details. to the Get Composer section. This primarily pertains to the homepage. I would suggest making each one of those headers there an anchor for easy linking from documentation.

4) Consider a "one liner" for Quick Installation

wget https://raw.githubusercontent.com/contentacms/contenta_jsonapi/8.x-2.x/installer.sh -v -O install.sh && \
chmod+x install.sh && \
./install.sh; rm -rf install.sh

I can probably come up with more but I will leave it at this for the time being.

e0ipso commented 5 years ago

I think you are right, there are a couple of installation methods that are not covered. I'd say that on the Installation section you could add alternatives to 4 with use drush and override the form values or use the GUI installer, …

Maybe 4 there could list them without detail and then link to a separate page with the alternative installation methods.

I'd like to avoid the language of default vs demo. Mainly because you can install the demo and turn it into a default with one click reverting the default content & config.