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: improve additional-hostnames.md #5045

Merged
merged 3 commits into from
Jul 4, 2023
Merged

docs: improve additional-hostnames.md #5045

merged 3 commits into from
Jul 4, 2023

Conversation

jowhannez
Copy link
Contributor

@jowhannez jowhannez commented Jun 29, 2023

Removed confusing string quotes that doesn't work in the config and example of console command that adds the hostnames for you.

The Issue

Quotes around the hostnames didn't work for me.

How This PR Solves The Issue

Removes the quotes from the text and suggests a console command

Manual Testing Instructions

Automated Testing Overview

Related Issue Link(s)

Release/Deployment Notes

Removed confusing string quotes that doesn't work in the config and example of console command that adds the hostnames for you.
@jowhannez jowhannez requested a review from a team as a code owner June 29, 2023 11:56
@rfay rfay changed the title Update additional-hostnames.md docs: Improve additional-hostnames.md Jun 29, 2023
@rfay
Copy link
Member

rfay commented Jun 29, 2023

I don't know why quote marks around the hostname entries wouldn't work... that's standard yaml. Please check again.

@gilbertsoft gilbertsoft changed the title docs: Improve additional-hostnames.md docs: improve additional-hostnames.md Jun 29, 2023
Copy link
Member

@gilbertsoft gilbertsoft left a comment

Choose a reason for hiding this comment

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

As said before by Randy, quotes should not be a problem but indention is wrong in the example.

docs/content/users/extend/additional-hostnames.md Outdated Show resolved Hide resolved
Copy link
Member

@gilbertsoft gilbertsoft left a comment

Choose a reason for hiding this comment

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

Added my suggestions. The additional example with ddev config ... looks good, thanks!

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.

Sorry for the wait! Added a suggestion to help with the flow and connect examples.

Two more things I can’t offer as suggestions, if you’re willing to update them:

  1. The opening sentence should probably describe both methods before illustrating them:

    You can add hostnames to a project by editing its config file or using the ddev config command.

    Use the additional_hostnames array in .ddev/config.yaml:

  2. Add yaml to the config snippets for syntax highlighting. (```yaml)

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

@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.

Thanks!

@rfay rfay merged commit 5927895 into ddev:master Jul 4, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants