Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install documentation requirements are not in sync / confusing. #140

Closed
3 of 5 tasks
pkarjala opened this issue Apr 10, 2018 · 1 comment
Closed
3 of 5 tasks

Install documentation requirements are not in sync / confusing. #140

pkarjala opened this issue Apr 10, 2018 · 1 comment

Comments

@pkarjala
Copy link

Submit a feature request or bug report

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

retlehs added a commit to roots/sage that referenced this issue Apr 13, 2018
oxyc added a commit to generoi/sage that referenced this issue Jun 27, 2018
* roots/master: (41 commits)
  Add uglifyjs plugin (roots#2070)
  Add missing trailing commas in 2f51b51
  Run autoprefixer before minification
  Enable source comments in Sass
  Fix travis CI build error (missing trailing comma)
  Tweaked SVGO settings
  Make template() compatible with wp admin
  9.0.1
  Update to Bootstrap 4.1.1
  Remove useless whitespace
  Auto-detect  scheme
  Close roots#2028 - Increase priority on comments_template filter
  Remove Font Awesome reference [ci skip]
  Bump sage-lib
  Close roots#1962 - Bump to Laravel 5.6
  Remove php blade shorthand
  Stable vs dev install messaging, ref roots/docs#140 [ci skip]
  Update some dependencies
  Update CHANGELOG [ci skip]
  Bootstrap 4.1.0
  ...
@insign
Copy link

insign commented Mar 10, 2021

[9.0MiB/0.00s] Loading composer repositories with package information
[23.1MiB/1.68s] Updating dependencies
[32.7MiB/1.76s] Your requirements could not be resolved to an installable set of packages.
[32.7MiB/1.77s] 
  Problem 1
    - illuminate/support[v5.6.0, ..., v5.6.39] require php ^7.1.3 -> your php version (8.0.2) does not satisfy that requirement.
    - Root composer.json requires illuminate/support 5.6.* -> satisfiable by illuminate/support[v5.6.0, ..., v5.6.39].

[20.2MiB/1.77s] Memory usage: 20.15MiB (peak: 32.76MiB), time: 1.77s

@retlehs retlehs closed this as completed Feb 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants