Skip to content

Commit

Permalink
added documentation for devcontainer
Browse files Browse the repository at this point in the history
  • Loading branch information
lipkau committed Jan 10, 2024
1 parent 9049b7a commit 003b011
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 34 deletions.
59 changes: 25 additions & 34 deletions .spelling
Original file line number Diff line number Diff line change
@@ -1,48 +1,39 @@
// AtlassianPS
alexsuslin
Atlassian
Atlassian's
Jira

// Module specific
worklog
timespan
multipart
captcha


// Powershell
pwsh
cmdlet
cmdlets
recurse
hashtable
posh
Passthru
EXTERNALHELP

// Person/Username
lipkau
bunke
brianbunke
thomykay
juneb
alexsuslin
axxel
beaudryj
brianbunke
bunke
captcha
clijsters
cmdlet
cmdlets
colhal
dejulia489
devcontainer
ebekker
EXTERNALHELP
hashtable
hmmwhatsthisdo
Jira
jkknorr
JohnAdders
juneb
kittholland
liam
leane
liam
lipkau
lukhase
padgers
JohnAdders
hmmwhatsthisdo

// misc
markdownlint
veyor
multipart
padgers
pandoc
Passthru
posh
pwsh
recurse
thomykay
timespan
veyor
worklog
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,26 @@ We appreciate [everyone](https://atlassianps.org/#people) who invests their time

Check out our guidelines on [Contributing] to our modules and documentation.

#### DevContainer

This repository offers a ["devcontainer"](https://containers.dev/) setup.

> **What are Development Containers?**
> A development container (or dev container for short) allows you to use
> a container as a full-featured development environment.
> It can be used to run an application, to separate tools, libraries,
> or runtimes needed for working with a codebase,
> and to aid in continuous integration and testing.
You can use the devcontainer to spin up a fine tuned development environment with
everything you need for working on this project.

The easiest way for using DevContainers is with [VS Code](https://code.visualstudio.com/),
its extension `ms-vscode-remote.remote-containers`,
and [docker](https://docs.docker.com/engine/install/).
When opening the repository in VS Code, it will recommend the installation of the extension.
And once installed, you will be prompted to "Reopen in Container".

## Tested on

* Windows Powershell v3
Expand Down

0 comments on commit 003b011

Please sign in to comment.