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

📝 Update DDEV doc for add-on #2754

Merged
merged 5 commits into from
Dec 22, 2022
Merged

📝 Update DDEV doc for add-on #2754

merged 5 commits into from
Dec 22, 2022

Conversation

CollierCZ
Copy link
Contributor

Why

Closes #2486

What's changed

Updated local dev overview with more of a separation between Docker-based tools and others.
Updated DDEV steps for add-on.
Added visual differentiation on another level of navigation.

@AnouckColson AnouckColson self-requested a review December 14, 2022 13:19
Copy link
Contributor

@AnouckColson AnouckColson left a comment

Choose a reason for hiding this comment

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

Very minor things related to lists as discussed. Otherwise it's perfect.

docs/src/development/local/ddev.md Show resolved Hide resolved
docs/src/development/local/_index.md Show resolved Hide resolved
docs/src/development/local/_index.md Show resolved Hide resolved
docs/src/development/local/_index.md Show resolved Hide resolved
docs/src/development/local/_index.md Show resolved Hide resolved
docs/src/development/local/ddev.md Show resolved Hide resolved
docs/src/development/local/ddev.md Show resolved Hide resolved
docs/src/development/local/ddev.md Outdated Show resolved Hide resolved
docs/src/development/local/ddev.md Outdated Show resolved Hide resolved
Copy link
Contributor

@lolautruche lolautruche left a comment

Choose a reason for hiding this comment

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

Added a few comments.
Looping in @rfay for another pair of eyes :)

docs/src/development/local/ddev.md Outdated Show resolved Hide resolved
docs/src/development/local/ddev.md Outdated Show resolved Hide resolved
docs/src/development/local/ddev.md Outdated Show resolved Hide resolved
docs/src/development/local/ddev.md Outdated Show resolved Hide resolved
---

[DDEV](https://ddev.readthedocs.io/en/stable/) is an open-source tool for local PHP development environments.
[DDEV](https://ddev.readthedocs.io/en/stable/) is an open-source tool for local PHP and Node.js development environments.
Copy link
Contributor

Choose a reason for hiding this comment

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

Node.js apps is not supported yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is that just the add-on? The repository description included Node.js, which is why I added it: https://github.com/drud/ddev

Copy link
Contributor

Choose a reason for hiding this comment

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

AFAIK it doesn't support Node.js webapps yet. Right @rfay ?

Copy link
Contributor

Choose a reason for hiding this comment

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

Node.js is significantly supported in DDEV, including webapps and other uses, but there is no mapping from Platform's support to DDEV's support.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure how to present that exactly. Guess I can leave out Node.js, just seemed unfortunate not to mention the support.

Copy link
Contributor

@rfay rfay left a comment

Choose a reason for hiding this comment

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

Minor comments; I may be missing context on the platform build comments, but I was assuming it was talking about working with DDEV.

docs/src/development/local/_index.md Show resolved Hide resolved
docs/src/development/local/_index.md Show resolved Hide resolved
docs/src/development/local/ddev.md Outdated Show resolved Hide resolved
docs/src/development/local/ddev.md Outdated Show resolved Hide resolved
lolautruche
lolautruche previously approved these changes Dec 19, 2022
Copy link
Contributor

@lolautruche lolautruche left a comment

Choose a reason for hiding this comment

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

With the exception of my suggestion, all good for me!

docs/src/development/local/_index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@AnouckColson AnouckColson left a comment

Choose a reason for hiding this comment

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

One minor suggestion

docs/src/development/local/ddev.md Outdated Show resolved Hide resolved
rfay
rfay previously approved these changes Dec 20, 2022
Copy link
Contributor

@rfay rfay left a comment

Choose a reason for hiding this comment

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

Minor comments, it will improve even more as time goes on.


If your app requires services to run, you have two options for developing locally:

- [Tethered local development](./tethered.md) involves running your app on a local web server
Copy link
Contributor

Choose a reason for hiding this comment

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

Wow, I had no idea. I certainly wouldn't recommend this to people, would suggest that this be offered as a second, distant alternative, rather than offering it first.

@@ -17,6 +18,14 @@ If you're starting from scratch, first [create a project from a PHP template]({{

Make sure your computer meets the [system requirements for DDEV](https://ddev.readthedocs.io/en/stable/#system-requirements).

For the integration to run smoothly, you also need the following tools:
Copy link
Contributor

Choose a reason for hiding this comment

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

We'll have to remember to remove this when we fix that dependency. Ah the joys of maintaining docs multiple places.

@CollierCZ CollierCZ merged commit 342c290 into main Dec 22, 2022
@CollierCZ CollierCZ deleted the ddev-integration branch December 22, 2022 19:33
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.

📝 Update DDEV docs for Platform integration
4 participants