Skip to content

Commit 8ef7ed0

Browse files
committed
docs: unified naming and etc.
Signed-off-by: Daniel Hu <[email protected]>
1 parent 9390225 commit 8ef7ed0

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build: ## Build dtm & plugins locally.
55
go build -buildmode=plugin -trimpath -gcflags="all=-N -l" -o plugins/argocdapp_0.0.1.so ./cmd/argocdapp/
66
go build -trimpath -gcflags="all=-N -l" -o dtm ./cmd/devstream/
77

8-
core: ## Build dtm core only, locally.
8+
build-core: ## Build dtm core only, locally.
99
go get ./...
1010
go build -trimpath -gcflags="all=-N -l" -o dtm ./cmd/devstream/
1111

README.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
## DevStream, What Is It Anyway?
1616

17-
DevStream is an open-source DevOps tool manager.
17+
DevStream is an open-source DevOps toolchain manager.
1818

1919
Imagine you are in a new project. Before writing the first line of code, you would have to figure out the tools needed in the whole Software Development Life Cycle (SDLC). You would probably need the following pieces:
2020

@@ -25,7 +25,7 @@ Imagine you are in a new project. Before writing the first line of code, you wou
2525
- someplace serving as the single source of truth for secrets and credentials (secrets manager, e.g., Vault by HashiCorp);
2626
- some tools for centralized logging and monitoring (for example, ELK, Prometheus/Grafana);
2727

28-
and maybe more. The list could go on for quite a bit.
28+
And maybe more. The list could go on for quite a bit.
2929

3030
And, there are multiple challenges in creating YOUR ideal SDLC workflow:
3131

@@ -35,7 +35,7 @@ And, there are multiple challenges in creating YOUR ideal SDLC workflow:
3535

3636
To be fair, there are a few integrated products out there that may contain everything you might need, but they might not suit your specific requirements perfectly. So, the chance is, you will still want to go out and do your research, find the best pieces for you, and integrate them. And, it would be a lot of operational overhead if all you had to do all day was install and uninstall and integrate things.
3737

38-
You probably have already seen where we are going with this, and you are right: DevStream, an open-source DevOps tool manager, aims to be the solution here.
38+
You probably have already seen where we are going with this, and you are right: DevStream, an open-source DevOps toolchain manager, aims to be the solution here.
3939

4040
Think of the Linux kernel V.S. different distributions. Different distros offer different packages so that you can always choose the best for your need.
4141

@@ -58,7 +58,10 @@ See [docs/architecture.md](./docs/architecture.md).
5858
## Build
5959

6060
```bash
61-
make
61+
# build dtm & plugins
62+
make build
63+
# build dtm only
64+
make build-core
6265
```
6366

6467
## Configuration
@@ -67,7 +70,7 @@ See [examples/config.yaml](./examples/config.yaml).
6770

6871
## Run
6972

70-
The CLI tool is named `dtm`, which is short for DevStream:
73+
The CLI tool is named `dtm`, which is an acronym of **d**evs**t**rea**m** or *devops toolchain manager*:
7174

7275
```bash
7376
./dtm install -f examples/config.yaml
@@ -78,7 +81,7 @@ The CLI tool is named `dtm`, which is short for DevStream:
7881
Inspired by [`git`](https://github.com/git/git#readme), the name is (depending on your mood):
7982

8083
- a symmetric, scientific acronym of **d**evs**t**rea**m**.
81-
- "devops tool manager": you're in a good mood, and it actually works for you.
84+
- "devops toolchain manager": you're in a good mood, and it actually works for you.
8285
- "dead to me": when it breaks.
8386

8487
## Contribute

0 commit comments

Comments
 (0)