Initial reorganization and rewrite of docs #73
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CONTRIBUTING.md
Outdated
|
|
||
| ## Debugging | ||
|
|
||
| You can easily launch and debug this extension within VSCode |
There was a problem hiding this comment.
nit. suggest: You can debug this extension within VSCode.
|
|
||
| ## Unit Tests | ||
|
|
||
| The project boilerplate provides unit tests in a vscode-hosted container of sorts (see /src/tests); |
There was a problem hiding this comment.
If these tests aren't used or developed, why do we have them?
There was a problem hiding this comment.
My guess -- these tests allow for more in depth integration testing with VS Code, and there may have been a goal when this was set up to add some integration testing down the line. However at this point, I am not completely sure.
srenatus
approved these changes
Sep 15, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What code changed, and why?
Since this project is moving beyond the Styra DAS integration with Styra Link to also supporting features in Enterprise OPA, the documentation and general branding needed a bit of a face lift. This renames the plugin to 'Styra VS Code Tools', and reorganizes the README to allow introducing the Enterprise OPA preview integration.
In addition, support has been consolidated into the generally supported
SUPPORT.mdfile, and the developer facingREADME.mdhas been consolidated into theCONTRIBUTING.mdfile.Lastly, in recognition that we want to fully embrace the name 'Enterprise OPA' for settings, the settings prefixes are updated to render the name more fully and correctly.
Definition of done
Documentation in the extension reflects the overall more general branding and provides information about the new preview features.
How to test
This is not really code to test, but the markdown can be rendered and read through. I highly request this, as there may well be things I missed in proofing the updates.