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

[docs] Quickstart for ExpressionEngine #4777

Merged
merged 6 commits into from
Mar 22, 2023

Conversation

rfay
Copy link
Member

@rfay rfay commented Mar 21, 2023

The Issue

Add a quickstart for ExpressionEngine

How This PR Solves The Issue

Shows zipfile and git checkout approaches.

Manual Testing Instructions

Try it out

Concerns

  • We need to find a better way to add more quickstarts. Django4 is soon to come, and the tab approach just doesn't scale.

@rfay rfay requested a review from a team as a code owner March 21, 2023 21:50
@rfay rfay requested a review from a team as a code owner March 21, 2023 21:54
Copy link
Sponsor Collaborator

@mattstein mattstein left a comment

Choose a reason for hiding this comment

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

Tested and nitpicked!

.spellcheckwordlist.txt Outdated Show resolved Hide resolved
docs/content/users/quickstart.md Outdated Show resolved Hide resolved

=== "ExpressionEngine Zipfile Download"

Download the ExpressionEngine code from [ExpressionEngine.com](https://expressionengine.com/), then:
Copy link
Sponsor Collaborator

Choose a reason for hiding this comment

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

Clarify we’re running things and link back to download+install instructions since they live in a different place for the Git install instructions:

Suggested change
Download the ExpressionEngine code from [ExpressionEngine.com](https://expressionengine.com/), then:
Download the ExpressionEngine code from [expressionengine.com](https://expressionengine.com/), then follow the [install instructions](https://docs.expressionengine.com/latest/installation/installation.html) by running the following:

Copy link
Member Author

Choose a reason for hiding this comment

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

The odd thing here is that the DDEV instructions are far simpler and easier than the expressionengine.com instructions. You don't have to do most of the things when you use DDEV.

Copy link
Sponsor Collaborator

@mattstein mattstein Mar 22, 2023

Choose a reason for hiding this comment

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

I figure if it goes sideways it’s nice to have the official reference, but no big deal. Would still lowercase the domain name and “run” the stuff that follows.

docs/content/users/quickstart.md Outdated Show resolved Hide resolved
docs/content/users/quickstart.md Outdated Show resolved Hide resolved

=== "ExpressionEngine Git Checkout"

```bash
Copy link
Sponsor Collaborator

Choose a reason for hiding this comment

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

Provide some context:

Suggested change
```bash
Follow the instructions in ExpressionEngine’s Git repository [README.md](https://github.com/ExpressionEngine/ExpressionEngine#how-to-install):
```bash

Copy link
Member Author

Choose a reason for hiding this comment

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

I like the context. Mostly you can't just follow the instructions.

Copy link
Sponsor Collaborator

Choose a reason for hiding this comment

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

I agree that the instructions here are much more straightforward, and it seems to me like they’re following the general steps anyway—the links out aren’t hard requirements (since the steps are immediately detailed below) but only providing context.

Copy link
Member Author

Choose a reason for hiding this comment

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

I added the links, just with "based on"

Copy link
Sponsor Collaborator

Choose a reason for hiding this comment

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

That reads better than my suggestion, thank you!

docs/content/users/quickstart.md Outdated Show resolved Hide resolved
docs/content/users/quickstart.md Show resolved Hide resolved
Co-authored-by: Matt Stein <m@ttste.in>
@rfay
Copy link
Member Author

rfay commented Mar 22, 2023

I like the contextual links to their docs, will add a commit to add those with less prescriptive angle on them.

@rfay rfay requested a review from mattstein March 22, 2023 02:33
@rfay rfay merged commit 47ee929 into ddev:master Mar 22, 2023
@rfay rfay deleted the 20230321_expressionengine branch March 22, 2023 02:58
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