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

README Doc Clarifications #180

Merged
merged 3 commits into from
May 27, 2021
Merged

README Doc Clarifications #180

merged 3 commits into from
May 27, 2021

Conversation

bussardrobbie
Copy link
Contributor

On a fresh machine, I found that not all PHP dependencies were fully resolved prior to building, after running "composer create-project linnovate/openideal-composer openideal" as per the doc. I don't have the expertise to add these dependencies to the build process, but this temporary doc update will shorten the google-aided learning curve for new users until these dependencies are resolved in the build process, if that's possible.

On a fresh machine, I found that not all PHP dependencies were fully resolved prior to building, after running "composer create-project linnovate/openideal-composer openideal" as per the doc. I don't have the expertise to add these dependencies to the build process, but this temporary doc update will shorten the google-aided learning curve for new users until these dependencies are resolved in the build process, if that's possible.
@zohar
Copy link
Member

zohar commented May 13, 2021

Hi @bussardrobbie , many thanks for your contribution!

We're relying almost entirely on Drupal and it's prerequisites. Therefor, instead of detailing the information, we can simply refer to the canonical information at https://www.drupal.org/docs/system-requirements

Would you like to change your patch and I'll commit it?

Removed specifics about dependencies, as these were based upon Drupal. Added an intro to Drupal and resource links to install prior to moving forward with the install/build process for OpenIdeaL.
@bussardrobbie
Copy link
Contributor Author

bussardrobbie commented May 13, 2021

@zohar Thanks for your prompt review. I have modified the input accordingly with links to Drupal's resources. While I'd like to keep everything about the install in one place, Drupal's requirements have a wide scope, and if those requirements change I don't want to create confusion there.

Please let me know if you would like any further edits or have other feedback prior to merge. Thank you!

@bussardrobbie bussardrobbie changed the title Add PHP Dependencies to README README Doc Clarifications May 17, 2021
@bussardrobbie
Copy link
Contributor Author

@zohar Following up with this- are there any further edits you'd like to see that would be beneficial?

@zohar
Copy link
Member

zohar commented May 27, 2021

@bussardrobbie Sorry I couldn't get to it faster. I proposed a change. lmk what you think.

Copy link
Contributor Author

@bussardrobbie bussardrobbie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm good with this. Thanks @zohar!

@zohar zohar merged commit 5266da7 into linnovate:3.x May 27, 2021
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

Successfully merging this pull request may close these issues.

None yet

2 participants