Skip to content

Add section about services to README.md file #2626

Open
@ametad

Description

@ametad

What problem are you trying to solve?

The README.md file is perfect to get an overview what to expect of the environment you can work with. There is a short installation guide of Devbox and how to invoke scripts. What scripts there are and what env vars there are. Even which packages are at your disposal.

But I miss a section about services:

  • which services there are;
  • how to start/stop them;
  • this documentation also ensures the reader knows about the existence of services;

What solution would you like?

A block in the documentation about services:

  • which services there are;
  • how to start/stop them;

About the same as how scripts are documented.

Alternatives you've considered

As an alternative I've used a script that does something like devbox services up. But I think that services is as important as scripts, packages, envs and therefore it should have it's own section in the README.md on generation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureNew feature or requesttriageIssue needs triage

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions