Skip to content

Commit db128d9

Browse files
committed
style: grammatical errors and style tweaks
1 parent 3ace799 commit db128d9

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/bluefin-dx.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,25 @@ Bluefin goes "all in" on cloud native development and is used differently than a
1515

1616
- Development is done in [devcontainers](https://containers.dev/)
1717
- Command line applications are installed using [homebrew](https://brew.sh)
18-
- Preconfigured ad-hoc containers for Ubuntu, Fedora, and Wolfi. Use whichever distribution you want.
18+
- Preconfigured ad-hoc containers for Ubuntu, Fedora, and Wolfi are included. Use whichever distribution you want.
1919

20-
This differs from traditional distributions by making the development process operating system agnostic. There is no equivalent to `apt install php` on Bluefin, development is done with `podman` or `docker` directly via an IDE.
20+
This differs from traditional distributions by making the development process operating system agnostic. There is no equivalent to `apt install php` on Bluefin; development is done with `podman` or `docker` directly via an IDE.
2121

2222
> We picked the cloud native pattern because local development in containers translates to deployment of containers on modern infrastructure.
2323
2424
![image](https://github.com/user-attachments/assets/51415b6c-b7fe-45e9-af74-c01694b26fbe)
2525

26-
The pattern in `bluefin-dx` (and `aurora-dx`) is centered around [devcontainers](https://containers.dev). Since the devcontainers live in the project's git repository, and they can deployed on any operating system, Linux, MacOS, or Windows (via WSL). This facilitates "distributed by default" development and avoids Linux users being "the odd one out" when working with teammates on other operating systems.
26+
The pattern in `bluefin-dx` (and `aurora-dx`) is centered around [devcontainers](https://containers.dev). Since devcontainers live in the project's git repository, they can be deployed on any operating system: Linux, MacOS, or Windows (via WSL). This facilitates "distributed by default" development and avoids Linux users being "the odd one out" when working with teammates on other operating systems.
2727

28-
Each project has a declarative environment that is intended to be start the user with a "best practice" cloud-native workflow out of the box. The [Ultimate Guide to Dev Containers](https://www.daytona.io/dotfiles/ultimate-guide-to-dev-containers) has a good write up of the advantages of using devcontainers. This means that the development environment is kept in version control instead of coupled to the host.
28+
Each project includes a declarative environment intended to start the user with a "best practice" cloud-native workflow out of the box. The [Ultimate Guide to Dev Containers](https://www.daytona.io/dotfiles/ultimate-guide-to-dev-containers) has a good write-up on the advantages of using devcontainers. This means that the development environment is kept in version control instead of coupled to the host.
2929

30-
Homebrew can also be used for installation of development tools. However it is recommended to avoid that and declare the project's dependencies in version control. It's so easy sometimes, [it's okay](https://www.youtube.com/shorts/lKwavoyaaFA).
30+
Homebrew can also be used to install development tools. However, it is recommended to avoid that and declare the project's dependencies in version control. It's so easy sometimes, [it's okay](https://www.youtube.com/shorts/lKwavoyaaFA).
3131

32-
> You can always use whatever you want, you do not need to use everything in here in order to be productive -- at the end of the day it's your computer, this is just a set of defaults.
32+
> You can always use whatever you want. You do not need to use everything in here in order to be productive -- at the end of the day it's your computer and this is just a set of defaults.
3333
3434
# Enabling Developer Mode
3535

36-
Turning on developer mode is a two step process:
36+
Turning on developer mode is a two-step process:
3737

3838
## Step 1: Turn it on
3939

@@ -51,7 +51,7 @@ Like all Universal Blue images, switching is atomic, allowing for clean switchin
5151

5252
## Visual Studio Code with Docker
5353

54-
[Visual Studio Code](https://code.visualstudio.com/) is included on the image as the default IDE. It comes with the [devcontainers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) already installed. It's the recommended developer experience, start here if you're new to containerized development!
54+
[Visual Studio Code](https://code.visualstudio.com/) is included in the image as the default IDE. It comes with the [devcontainers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) already installed. It's the recommended developer experience, so start here if you're new to containerized development!
5555

5656
- [Dev Containers Documentation](https://code.visualstudio.com/docs/devcontainers/containers) - you can skip most of the installation instructions and go directly to [the tutorial](https://code.visualstudio.com/docs/devcontainers/tutorial#_install-the-extension)
5757
- [Dev Containers Specification](https://containers.dev/)
@@ -63,7 +63,7 @@ The most current [Docker Engine](https://docs.docker.com/engine/) is included by
6363

6464
## Devpod
6565

66-
DevPod is an open source tool used to create reproducible developer environments. Each developer environment runs in a separate container and is specified through a `devcontainer.json`. Codespaces but open-source, client-only and unopinionated: Works with any IDE and lets you use any cloud, kubernetes or just localhost `docker`.
66+
DevPod is an open source tool used to create reproducible developer environments. Each developer environment runs in a separate container and is specified through a `devcontainer.json` file. It's like Codespaces but is open-source, client-only, and unopinionated: it works with any IDE and lets you use any cloud, Kubernetes, or even local `docker` environment.
6767

6868
- [Devpod Website](https://devpod.sh/)
6969
- [Devpod Documentation](https://devpod.sh/docs/what-is-devpod)
@@ -78,11 +78,11 @@ Check out this talk from [Rich Burroughs](https://timeline.richburroughs.dev/):
7878

7979
![Podman Desktop](https://github.com/user-attachments/assets/69f64ed1-7fcc-4040-9a3d-12b71308da1b)
8080

81-
[Podman Desktop](https://podman-desktop.io/) is included to provide container management. Check out the Podman Desktop [documentation](https://podman-desktop.io/docs/intro) for more information. All the upstream `podman` tools are included. This is the default system container runtime, and is the recommended developer configuration that Fedora ships with.
81+
[Podman Desktop](https://podman-desktop.io/) is included to provide container management. Check out the Podman Desktop [documentation](https://podman-desktop.io/docs/intro) for more information. All the upstream `podman` tools are included. This is the default system container runtime and is the recommended developer configuration that Fedora ships with.
8282

83-
> Though Bluefin defaults to docker and vscode for development, all of the Fedora upstream tools are included for those that prefer that experience.
83+
> Though Bluefin defaults to docker and vscode for development, all of the Fedora upstream tools are included for those who prefer that experience.
8484
85-
## Built in Performance Tooling
85+
## Built-in Performance Tooling
8686

8787
[Sysprof](https://www.sysprof.com/) is included as a systemwide performance profiler. As well as [Brendan Gregg's](https://www.brendangregg.com/) recommended CLI tools:
8888

@@ -93,7 +93,7 @@ Thanks to Ubuntu and Canonical for the [detailed specification](https://discours
9393
## Quality of Life Improvements
9494

9595
- [Cockpit](https://cockpit-project.org/) for local and remote management
96-
- A collection of well curated monospace fonts
96+
- A collection of well-curated monospace fonts
9797
- [Tailscale](https://universal-blue.discourse.group/t/tailscale-vpn-on-bluefin/290) for VPN
9898
- [Just](https://github.com/casey/just) task runner for automation tasks
9999
- `fish` and `zsh` available as optional shells
@@ -111,7 +111,7 @@ Thanks to Ubuntu and Canonical for the [detailed specification](https://discours
111111
- [fzf](https://github.com/junegunn/fzf) for command line fuzzy finding
112112
- [ripgrep](https://github.com/BurntSushi/ripgrep) for search
113113
- [tealdeer](https://github.com/dbrgn/tealdeer) for `tldr`
114-
- [television](https://github.com/alexpasmantier/television) - a blazing fast general purpose fuzzy finder TUI - (`tv`)
114+
- [television](https://github.com/alexpasmantier/television) - a blazing fast general-purpose fuzzy finder TUI - (`tv`)
115115
- [trash-cli](https://github.com/andreafrancia/trash-cli) to manage the system trashcan. (Strongly recommended for new CLI users)
116116
- [ugrep](https://github.com/Genivia/ugrep) for grep
117117
- [yq](https://github.com/mikefarah/yq) - for yaml, json, and xml processing
@@ -131,7 +131,7 @@ Use BoxBuddy's interface to create your own pet containers from whichever distri
131131

132132
![image](https://github.com/user-attachments/assets/79570148-98f9-458f-b46e-2a87cfaa00ed)
133133

134-
For CLI warriors you can manage your containers with the Terminal's built in container support:
134+
For CLI warriors you can manage your containers with the Terminal's built-in container support:
135135

136136
![image](https://github.com/user-attachments/assets/2a4dc4b5-f1a8-4781-80a4-92ea4dfeeb97)
137137

@@ -153,9 +153,9 @@ The included [Terminal](https://gitlab.gnome.org/chergert/ptyxis) includes a hos
153153

154154
The JetBrains blog also has more information on JetBrains Dev Containers support:
155155

156-
- [Using Dev Containers in JetBrains IDEs](https://blog.jetbrains.com/idea/2024/07/using-dev-containers-in-jetbrains-ides-part-1/) – Part 1
156+
- [Using Dev Containers in JetBrains IDEs – Part 1](https://blog.jetbrains.com/idea/2024/07/using-dev-containers-in-jetbrains-ides-part-1/)
157157

158-
Devpod also has support for JetBrains
158+
Devpod also has support for JetBrains:
159159

160160
- [Devpod Quickstart JetBrains](https://devpod.sh/docs/getting-started/quickstart-jetbrains)
161161

@@ -178,4 +178,4 @@ Devpod also has support for JetBrains
178178

179179
- [virt-manager](https://virt-manager.org/) and associated tooling (KVM, qemu)
180180
- [Incus](https://linuxcontainers.org/incus/) provides system containers
181-
- [LXC](https://linuxcontainers.org/) and [LXD](https://ubuntu.com/lxd) are also provided for compatibility reasons, however these tools are deprecated and will be removed in Spring 2025
181+
- [LXC](https://linuxcontainers.org/) and [LXD](https://ubuntu.com/lxd) are also provided for compatibility reasons, however, these tools are deprecated and will be removed in Spring 2025

0 commit comments

Comments
 (0)