Skip to content

Commit abe754f

Browse files
authored
migrations: replace vscode remote containers and docker compose dev environment from open dev containers
this changeset is to replace docker compose and vscode remote containers with the new open dev containers. - change .devcontainer.json schema to support open devcontainers - use node lts docker image instead of vscode node image - use dev container lifecycle events to install docsify and serve content - install docsify-cli globally - reword and improve documentation content BREAKING CHANGE: now that we have the new version of dev containers, the vs code and docker compose versions are no longer supported.
1 parent 871bd26 commit abe754f

21 files changed

+370
-354
lines changed

.devcontainer/Dockerfile

-14
This file was deleted.

.devcontainer/devcontainer.json

+65-45
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,74 @@
11
{
2-
"name": "try-docsify",
3-
"dockerComposeFile": "docker-compose.yml",
4-
"service": "app",
5-
"workspaceFolder": "/workspace",
6-
7-
// Set *default* container specific settings.json values on container create.
8-
"settings": {
9-
"terminal.integrated.shell.linux": "/bin/zsh",
2+
"name": "try-docsify",
3+
// See complete list https://hub.docker.com/_/node/tags?page=1&name=bullseye
4+
"image": "node:lts-bullseye",
5+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
6+
"forwardPorts": [
7+
// Http
8+
3000,
9+
// Https
10+
3001
11+
],
1012

11-
// Extensions
12-
"eslint.workingDirectories": [
13-
{
14-
"directory": "./test-project",
15-
"changeProcessCWD": true
16-
}
17-
],
18-
"liveServer.settings.NoBrowser": true,
19-
"liveServer.settings.port": 5500
20-
},
13+
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
14+
"remoteUser": "root",
2115

22-
// Add the IDs of extensions you want installed when the container is created.
23-
"extensions": [
24-
"ms-azuretools.vscode-docker",
16+
// Add more features. See complete list https://github.com/devcontainers/features
17+
"features": {
18+
// Permission denied. More info: https://github.com/devcontainers/features/issues/440
19+
"ghcr.io/devcontainers/features/common-utils:2": {
20+
"configureZshAsDefaultShell": true
21+
},
22+
"ghcr.io/devcontainers/features/github-cli:1": {}
23+
},
24+
"containerEnv": {},
25+
// Configure tool-specific properties.
26+
"customizations": {
27+
// Configure properties specific to VS Code.
28+
"vscode": {
29+
// Add the IDs of extensions you want installed when the container is created.
30+
"extensions": [
31+
"ms-azuretools.vscode-docker",
32+
"ms-vscode-remote.remote-containers",
33+
"redhat.vscode-yaml",
34+
35+
"visualstudioexptteam.vscodeintellicode",
36+
"dbaeumer.vscode-eslint",
37+
"usernamehw.errorlens",
38+
"christian-kohler.npm-intellisense",
39+
"eg2.vscode-npm-script",
40+
41+
"ritwickdey.live-sass",
42+
43+
"editorconfig.editorconfig",
44+
"esbenp.prettier-vscode",
45+
46+
"bierner.github-markdown-preview",
47+
"streetsidesoftware.code-spell-checker",
48+
"znck.grammarly",
2549

26-
"dbaeumer.vscode-eslint",
27-
"christian-kohler.npm-intellisense",
28-
"eg2.vscode-npm-script",
29-
"ritwickdey.liveserver",
30-
"ritwickdey.live-sass",
50+
"redhat.fabric8-analytics",
51+
"ms-vscode.wordcount"
52+
],
53+
// Set *default* container specific settings.json values on container create.
54+
"settings": {
55+
"terminal.integrated.defaultProfile.linux": "zsh",
3156

32-
"visualstudioexptteam.vscodeintellicode",
33-
"ms-vscode.wordcount",
34-
"editorconfig.editorconfig",
35-
"esbenp.prettier-vscode",
36-
"streetsidesoftware.code-spell-checker",
37-
"znck.grammarly",
38-
"redhat.fabric8-analytics",
39-
"redhat.vscode-yaml",
40-
"bierner.github-markdown-preview"
41-
],
57+
"editor.formatOnPaste": true,
58+
"editor.guides.bracketPairs": "active",
59+
"debug.internalConsoleOptions": "neverOpen",
4260

43-
// Use 'forwardPorts' to make a list of ports inside the container available locally.
44-
"forwardPorts": [
45-
// Live server port
46-
5500
47-
],
61+
"scm.defaultViewMode": "tree",
4862

49-
// Use 'postCreateCommand' to run commands after the container is created.
50-
"postCreateCommand": "zsh .devcontainer/post-create.zsh",
63+
"files.watcherExclude": {
64+
"**/node_modules/**": true
65+
}
66+
}
67+
}
68+
},
5169

52-
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
53-
"remoteUser": "node"
70+
// Use 'updateContentCommand' to run commands after the container is successfully created.
71+
"updateContentCommand": "yarn global add docsify-cli@latest --prefix /usr/local",
72+
// Use 'postCreateCommand' to run commands after the container is created.
73+
"postCreateCommand": "docsify serve . -p 3000"
5474
}

.devcontainer/docker-compose.yml

-36
This file was deleted.

.devcontainer/post-create.zsh

-7
This file was deleted.

.dockerignore

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
#
2+
# macOS ignores
3+
#
4+
5+
# General
6+
.DS_Store
7+
.AppleDouble
8+
.LSOverride
9+
10+
# Icon must end with two \r
11+
Icon
12+
13+
14+
# Thumbnails
15+
._*
16+
17+
# Files that might appear in the root of a volume
18+
.DocumentRevisions-V100
19+
.fseventsd
20+
.Spotlight-V100
21+
.TemporaryItems
22+
.Trashes
23+
.VolumeIcon.icns
24+
.com.apple.timemachine.donotpresent
25+
26+
# Directories potentially created on remote AFP share
27+
.AppleDB
28+
.AppleDesktop
29+
Network Trash Folder
30+
Temporary Items
31+
.apdisk
32+
33+
#
34+
# Windows ignores
35+
#
36+
37+
# Windows thumbnail cache files
38+
Thumbs.db
39+
Thumbs.db:encryptable
40+
ehthumbs.db
41+
ehthumbs_vista.db
42+
43+
# Dump file
44+
*.stackdump
45+
46+
# Folder config file
47+
[Dd]esktop.ini
48+
49+
# Recycle Bin used on file shares
50+
$RECYCLE.BIN/
51+
52+
# Windows Installer files
53+
*.cab
54+
*.msi
55+
*.msix
56+
*.msm
57+
*.msp
58+
59+
# Windows shortcuts
60+
*.lnk

.gitignore

+112-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
# Project Specific Ignores
33
#
44

5-
65
#
76
# VS Code Ignores
87
#
@@ -16,9 +15,117 @@
1615
# Local History for Visual Studio Code
1716
.history/
1817

18+
#
19+
# NodeJS Ignores
20+
#
21+
22+
# Logs
23+
logs
24+
*.log
25+
npm-debug.log*
26+
yarn-debug.log*
27+
yarn-error.log*
28+
lerna-debug.log*
29+
30+
# Diagnostic reports (https://nodejs.org/api/report.html)
31+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
32+
33+
# Runtime data
34+
pids
35+
*.pid
36+
*.seed
37+
*.pid.lock
38+
39+
# Directory for instrumented libs generated by jscoverage/JSCover
40+
lib-cov
41+
42+
# Coverage directory used by tools like istanbul
43+
coverage
44+
*.lcov
45+
46+
# nyc test coverage
47+
.nyc_output
48+
49+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
50+
.grunt
51+
52+
# Bower dependency directory (https://bower.io/)
53+
bower_components
54+
55+
# node-waf configuration
56+
.lock-wscript
57+
58+
# Compiled binary addons (https://nodejs.org/api/addons.html)
59+
build/Release
60+
61+
# Dependency directories
62+
node_modules/
63+
jspm_packages/
64+
65+
# TypeScript v1 declaration files
66+
typings/
67+
68+
# TypeScript cache
69+
*.tsbuildinfo
70+
71+
# Optional npm cache directory
72+
.npm
73+
74+
# Optional eslint cache
75+
.eslintcache
76+
77+
# Microbundle cache
78+
.rpt2_cache/
79+
.rts2_cache_cjs/
80+
.rts2_cache_es/
81+
.rts2_cache_umd/
82+
83+
# Optional REPL history
84+
.node_repl_history
85+
86+
# Output of 'npm pack'
87+
*.tgz
88+
89+
# Yarn Integrity file
90+
.yarn-integrity
91+
92+
# dotenv environment variables file
93+
.env
94+
.env.test
95+
96+
# parcel-bundler cache (https://parceljs.org/)
97+
.cache
98+
99+
# Next.js build output
100+
.next
101+
102+
# Nuxt.js build / generate output
103+
.nuxt
104+
dist
105+
106+
# Gatsby files
107+
.cache/
108+
# Comment in the public line in if your project uses Gatsby and *not* Next.js
109+
# https://nextjs.org/blog/next-9-1#public-directory-support
110+
# public
111+
112+
# vuepress build output
113+
.vuepress/dist
114+
115+
# Serverless directories
116+
.serverless/
117+
118+
# FuseBox cache
119+
.fusebox/
120+
121+
# DynamoDB Local files
122+
.dynamodb/
123+
124+
# TernJS port file
125+
.tern-port
19126

20127
#
21-
# macOS Ignores
128+
# macOS ignores
22129
#
23130

24131
# General
@@ -29,6 +136,7 @@
29136
# Icon must end with two \r
30137
Icon
31138

139+
32140
# Thumbnails
33141
._*
34142

@@ -48,9 +156,8 @@ Network Trash Folder
48156
Temporary Items
49157
.apdisk
50158

51-
52159
#
53-
# Windows Ignores
160+
# Windows ignores
54161
#
55162

56163
# Windows thumbnail cache files
@@ -76,4 +183,4 @@ $RECYCLE.BIN/
76183
*.msp
77184

78185
# Windows shortcuts
79-
*.lnk
186+
*.lnk

docs/.nojekyll .nojekyll

File renamed without changes.

0 commit comments

Comments
 (0)