Merge pull request #961 from rancher/processes

opni enhancement proposal template and vale style guide

.gitignore

@@ -43,3 +43,6 @@ index.yaml
 # kubeconfigs
 **/kubeconfig.yaml
 **/kubeconfig.json
+
+# vale styles
+styles/*

.vale.ini

@@ -0,0 +1,10 @@
+StylesPath = styles
+
+Vocab = Opni
+
+MinAlertLevel = suggestion
+
+Packages = Microsoft, proselint
+
+[*]
+BasedOnStyles = Vale, Microsoft, proselint

enhancements/YYYYMMDD-template.md

@@ -0,0 +1,35 @@
+# Title: 
+A clear and concise title that describes the proposed change or new feature.
+
+## Summary: 
+A brief overview of the proposed change or new feature, including its purpose and the problem it is intended to solve.
+
+## Use case: 
+A description of the specific scenario or context in which the proposed change or new feature would be used.
+
+## Benefits: 
+A list of the benefits that the proposed change or new feature would provide, such as increased productivity, improved user experience, or reduced costs.
+
+## Impact: 
+A description of how the proposed change or new feature would impact the existing system, including any potential trade-offs or drawbacks.
+
+## Implementation details: 
+A description of how the proposed change or new feature would be implemented, including any necessary technical details or considerations. Be sure to specify any corresponding UI/UX changes.
+
+## Acceptance criteria: 
+A list of specific criteria that must be met in order for the proposed change or new feature to be considered complete and ready for deployment.
+
+## Supporting documents: 
+Any relevant supporting documents, such as user stories, wireframes, or mockups, that provide additional context or information about the proposed change or new feature.
+
+## Dependencies: 
+Any dependencies that must be met before the proposal can be implemented. This could include other projects, external systems, or third-party services that must be in place before the proposal can be completed.
+
+## Risks and contingencies: 
+A description of any risks or contingencies associated with the proposed change or new feature, and a plan for addressing them.
+
+## Level of Effort: 
+An estimate of time (in developer days/hours) required to implement the proposed change or new feature. Assume all dependencies are working and do not factor risks and contingencies associated with dependencies in the LOE calculation.
+
+## Resources: 
+A list of software/hardware resources required to implement the OEP.

styles/Vocab/Opni/accept.txt

@@ -0,0 +1,3 @@
+[Oo]pni
+subpage
+failover

vale.md

@@ -0,0 +1,18 @@
+# Using vale.sh
+
+Vale is a natural language linter that helps writers improve their prose. Opni uses it to standardize markdown files.
+
+## Installing vale
+Refer to: https://vale.sh/docs/vale-cli/installation/
+
+The vale configuration file used for Opni is located at `.vale.ini`
+
+After installing, run `vale sync` to fetch the styles specified in the configuration file. This only needs to be run once.
+
+## Usage
+
+Single file:
+`vale path/to/file.md`
+
+Multiple files:
+`vale path/to/directory/`