Skip to content

Commit

Permalink
docs: remove vscode directory and add note on configuring ide (#75)
Browse files Browse the repository at this point in the history
## Description

remove vscode directory and add readme note on configuring json schema
validation


## Related Issue

Fixes #
<!-- or -->
Relates to #

## 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-software-factory/blob/main/CONTRIBUTING.md#developer-workflow)
followed
  • Loading branch information
zachariahmiller authored Jul 3, 2024
1 parent 0e692b4 commit 38ef2a7
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 16 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
zarf-package-*
uds-bundle-*
zarf-sbom
.vscode/
16 changes: 0 additions & 16 deletions .vscode/settings.json

This file was deleted.

4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,7 @@ Alternatively, you can deploy from OCI by running the following two commands:
uds deploy swf-dev:0.2.2
```
<!-- x-release-please-end -->

## 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.

0 comments on commit 38ef2a7

Please sign in to comment.