From c087596604d2296ca9d05e915d59d6c715fd90a9 Mon Sep 17 00:00:00 2001 From: zamaz <71521611+zachariahmiller@users.noreply.github.com> Date: Wed, 3 Jul 2024 13:36:57 -0400 Subject: [PATCH] chore: remove and gitignore .vscode directory (#159) ## Description remove and gitignore .vscode directory ## Related Issue Fixes # https://github.com/defenseunicorns/uds-software-factory/issues/72 ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Other (security config, docs update, etc) ## Checklist before merging - [x] Test, docs, adr added or updated as needed - [x] [Contributor Guide Steps](https://github.com/defenseunicorns/uds-package-gitlab/blob/main/CONTRIBUTING.md#developer-workflow) followed --- .gitignore | 2 +- .vscode/settings.json | 43 ------------------------------------------- README.md | 4 ++++ 3 files changed, 5 insertions(+), 44 deletions(-) delete mode 100644 .vscode/settings.json diff --git a/.gitignore b/.gitignore index 81511050..c78a6c36 100644 --- a/.gitignore +++ b/.gitignore @@ -8,7 +8,7 @@ defense-unicorns-distro/preflight.sh .terraform tmp zarf-sbom - +.vscode/ .cache/ .idea/ build/ diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index ac25f0a4..00000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "debug.javascript.terminalOptions": { - "enableTurboSourcemaps": true, - "resolveSourceMapLocations": [ - "${workspaceFolder}/**", - "node_modules/kubernetes-fluent-client/**", - "node_modules/pepr/**" - ] - }, - "yaml.schemas": { - "https://raw.githubusercontent.com/defenseunicorns/uds-cli/v0.11.2/uds.schema.json": [ - "uds-bundle.yaml" - ], - "https://raw.githubusercontent.com/defenseunicorns/uds-cli/v0.11.2/tasks.schema.json": [ - "tasks.yaml", - "tasks/**/*.yaml", - "src/**/validate.yaml" - ], - "https://raw.githubusercontent.com/defenseunicorns/zarf/v0.35.0/zarf.schema.json": [ - "zarf.yaml" - ] - }, - "cSpell.words": [ - "alertmanager", - "Authservice", - "automount", - "controlplane", - "crds", - "distros", - "ironbank", - "Kiali", - "Kyverno", - "MITM", - "neuvector", - "opensource", - "promtail", - "Quickstart", - "Gitlab", - "seccomp", - "Sysctls", - "Velero" - ] - } \ No newline at end of file diff --git a/README.md b/README.md index 156c985a..68751e9f 100644 --- a/README.md +++ b/README.md @@ -94,3 +94,7 @@ The released packages can be found in [ghcr](https://github.com/defenseunicorns/ ## Contributing Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) + +## Development + +When developing this package it is ideal to utilize the json schemas for UDS Bundles, Zarf Packages and Maru Tasks. This involves configuring your IDE to provide schema validation for the respective files used by each application. For guidance on how to set up this schema validation, please refer to the [guide](https://github.com/defenseunicorns/uds-common/blob/main/docs/development-ide-configuration.md) in uds-common. \ No newline at end of file