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
docs: show initial and project-checkout Backdrop installation #5781
Conversation
This PR fixes 2 issues with the current documenation: - Corrects clone target - Sets DDEV config to "backdrop" As I don't use Backdrop, I'm not sure if this "best practises". However, these steps did result in the "site setup" screen displaying.
Pinging @klonos because they have been active in the issue queus recently regarding backdrop. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this, and so glad to have Backdrop folk around again after a very long time!
The idea here was that people had an existing project. Why don't we change it to show two alternates.
- Your example (cloning backdrop itself, although their site might suggest downloading a tarball instead)
- The intention here, checking out an existing project built on backdrop.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like it's going to be fine to me, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've left one comment about the styling of the new projects tab. Aside that I've tested the install with the git clone approach and it worked like a charm.
In regards of the existing projects tab i am not that much of a fan of that kind of quickstarts due to the fact that it is none functional and sort of abstract in part. personally they often confuse me more than they help. one idea instead of having a tab for existing projects might be to provide another quickstart for installing backdrop via an archive.
a few weeks back when i worked on the restructuring of the quickstarts i also tried to provide quickstart guides for none functional ones like backdrop had and make the quickstart guides more consistent. the steps i came up with for backdrop are as follows:
curl -LJO https://github.com/backdrop/backdrop/releases/latest/download/backdrop.zip
unzip ./backdrop.zip && rm backdrop.zip && mv -f ./backdrop/{.,}* . && rm -r backdrop
ddev config --auto
ddev start
ddev launch
that archive always provides the latest stable version of backdrop and the second chained command unpacks the archive and moves things around a bit and cleans up things at the end.
Not sure which style the community prefers. My attempt was to "correct" as opposed to "improve". |
yeah i agree that fixing the current completely none functional state is the right thing to do. improving and making recipes more consistent might be better the step afterwards. but still the current state of the quickstart is
the quickstart in the That was the idea behind my suggestion instead of adding the abstract existing projects quickstart adding the quickstart about downloading an archive. that is a pattern many quickstarts apply. providing one quickstart for composer or the download of an archive if no composer workflow is available and one quickstart for git. that was the reason why i've suggested the archive download instead of the existing projects example. from my perspective quickstarts should be what the name implies a quick actionable recipe you are able to spin up a CMS you have literally no idea about. |
The Issue
The current Backdrop quickstart fails:
How This PR Solves The Issue
This PR fixes 2 issues with the current documenation:
As I don't use Backdrop, I'm not sure if this "best practises". However, these steps did result in the "site setup" screen displaying.
Manual Testing Instructions
Automated Testing Overview
Related Issue Link(s)
Release/Deployment Notes