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] Update example service list #4263

Merged
merged 2 commits into from
Oct 5, 2022

Conversation

mattstein
Copy link
Sponsor Collaborator

@mattstein mattstein commented Oct 5, 2022

The Problem/Issue/Bug:

After #4200 and subsequent updates to some GitHub repository descriptions, the ddev get --list example is stale.

How this PR Solves The Problem:

This fixes that situation, in a refreshingly small PR. Also cheats by fixing an “addon” that should be “add-on”, and capitalizing Memcached which, against all odds, appears to be a proper noun for the product.

Manual Testing Instructions:

https://ddev.readthedocs.io/en/stable/developers/testing-docs/#preview-your-changes

Automated Testing Overview:

Only Markdown; no new tests needed.

Release/Deployment notes:

n/a

@mattstein mattstein self-assigned this Oct 5, 2022
@mattstein mattstein requested a review from rfay October 5, 2022 22:16
@mattstein mattstein marked this pull request as ready for review October 5, 2022 22:17
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.

Looks good to me. That's the actual output now right?

@mattstein
Copy link
Sponsor Collaborator Author

@rfay Actual output right now does not include the cheats I mentioned above:

❯ ddev get --list
┌───────────────────────────┬──────────────────────────────────────────────────┐
│ ADD-ON                    │ DESCRIPTION                                      │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-beanstalkd      │ Beanstalkd for DDEV*                             │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-memcached       │ Install memcached as an extra service in DDEV*   │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-mongo           │ MongoDB addon for DDEV*                          │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-pdfreactor      │ PDFreactor service for DDEV*                     │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-elasticsearch   │ Elasticsearch add-on for DDEV*                   │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-browsersync     │ Auto-refresh HTTPS page on changes with DDEV*    │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-drupal9-solr    │ Drupal 9 Apache Solr installation for DDEV*      │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-varnish         │ Varnish reverse proxy add-on for DDEV*           │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-redis           │ Redis service for DDEV*                          │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-adminer         │ Adminer service for DDEV*                        │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-cron            │ Schedule commands to execute within DDEV*        │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-proxy-support   │ Support HTTP/HTTPS proxies with DDEV*            │
├───────────────────────────┼──────────────────────────────────────────────────┤
│ drud/ddev-redis-commander │ Redis Commander for use with DDEV Redis service* │
└───────────────────────────┴──────────────────────────────────────────────────┘
Add-ons marked with '*' are official, maintained DDEV add-ons.

(Lowercase “memcached” and MongoDB “addon”.)

@rfay
Copy link
Member

rfay commented Oct 5, 2022

Can we actually just fix the repos in question? It's just a moment.

@rfay
Copy link
Member

rfay commented Oct 5, 2022

  • Fixed Memcached
  • Made Elasticsearch addon

Is that it?

@mattstein
Copy link
Sponsor Collaborator Author

Those are the repository descriptions, right? I assume only you can edit them, but if I can I’d be happy to do it.

I have more notes on those descriptions but haven’t filed them in an issue yet. Example:

Install memcached as an extra service in DDEV

This might as well be shortened so it matches its peers:

Memcached service for DDEV

@mattstein
Copy link
Sponsor Collaborator Author

Made Elasticsearch addon

This is the opposite of the direction I’ve been going—where “add-on” is the winner. It’s used more frequently in the docs and in repository descriptions.

@rfay
Copy link
Member

rfay commented Oct 5, 2022

Reverted Elasticsearch and changed Mongo to add-on

@mattstein
Copy link
Sponsor Collaborator Author

@rfay Was diffing this PR against my CLI output; what determines the order these come back in? Is it possible to alphabetize by repository name or is there an order I’m failing to pick up on?

@rfay
Copy link
Member

rfay commented Oct 5, 2022

I think it's just the github api with no intervention right now. Could probably be sorted, most likely after we get it.

Use `→ ` for user action, include entire current output.
@mattstein
Copy link
Sponsor Collaborator Author

mattstein commented Oct 5, 2022

Just updated this to include all the items I see in my current CLI output, and to again use that to signify user input.

@rfay
Copy link
Member

rfay commented Oct 5, 2022

OK, let me know when you're happy.

@mattstein
Copy link
Sponsor Collaborator Author

@rfay Officially happy!

@rfay rfay merged commit 5c32709 into ddev:master Oct 5, 2022
@mattstein mattstein deleted the docs/update-service-list branch October 5, 2022 23:34
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