Skip to content

WIP: state based alerting #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion common/src/components/TerminalOutput.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,19 @@ function ansi2HTML(str, command) {


export default function Ansi({ command, children }) {
let txt = ""
try {

let txt = `❯ ${command}<br/>` + children.props.children.replaceAll("\n", "<br/>")

if (children?.props?.children) {
txt = `❯ ${command}<br/>` + children.props.children.replaceAll("\n", "<br/>")
} else {
txt = `❯ ${command}`
}
} catch (e) {
console.error(e)
txt = ""
}

let html = new Convert().toHtml(txt, command)
return (
Expand Down
16 changes: 16 additions & 0 deletions mission-control/blog/state-based-alerting/canary.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: kubernetes-checks
annotations:
trace: "true"
spec:
schedule: "@every 5m"
kubernetes:
- name: pods
kind: Pod
namespaceSelector:
name: default
resource:
name: test-pod
healthy: true # use the is-healthy library to check the health of pods
500 changes: 500 additions & 0 deletions mission-control/blog/state-based-alerting/index.md

Large diffs are not rendered by default.

502 changes: 502 additions & 0 deletions mission-control/blog/state-based-alerting/index.mdx

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions mission-control/blog/state-based-alerting/nginx.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
apiVersion: v1
kind: Pod
metadata:
name: test-pod
spec:
containers:
- image: nginx:invalid
Copy link
Preview

Copilot AI May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The image tag 'nginx:invalid' appears to be a mistake that may cause runtime failures; please verify and update it with a valid tag.

Suggested change
- image: nginx:invalid
- image: nginx:latest

Copilot uses AI. Check for mistakes.

name: nginx
Binary file added mission-control/static/img/PodCrashLooping.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 55 additions & 0 deletions prompts/blog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
Write a 1250-1500 introductor blog post for a DevOps / Platform Engineering focused product or feature.

Check failure on line 1 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L1

[Flanksource.Spelling] Is 'introductor' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'introductor' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 1, "column": 19}}}, "severity": "ERROR"}
Copy link
Preview

Copilot AI May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace 'introductor' with 'introductory' to improve clarity.

Suggested change
Write a 1250-1500 introductor blog post for a DevOps / Platform Engineering focused product or feature.
Write a 1250-1500 introductory blog post for a DevOps / Platform Engineering focused product or feature.

Copilot uses AI. Check for mistakes.


The tone should be developer-friendly, technical and informative without sounding salesy or promotional.

Check failure on line 3 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L3

[Flanksource.Spelling] Is 'salesy' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'salesy' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 3, "column": 83}}}, "severity": "ERROR"}

The writing should have no fluff, use short punchy sentences, avoid buzzwords and speak like a senior engineer would.

The purpose of this copy is to generate interest in a new approach to a feature, educate DevOps engineers, increase awareness and reduce friction to trial

Speak directly to platform engineers, SREs and DevOps leads and address their pain points of change and tool fatigue.

Check failure on line 9 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L9

[Flanksource.Spelling] Is 'SREs' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'SREs' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 9, "column": 39}}}, "severity": "ERROR"}

Check notice on line 9 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L9

[Flanksource.ComplexWords] Consider using 'discuss' instead of 'address'.
Raw output
{"message": "[Flanksource.ComplexWords] Consider using 'discuss' instead of 'address'.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 9, "column": 65}}}, "severity": "INFO"}

Avoid generic language. Favor clarity over cleverness. Highlight real-world outcomes and developer-first thinking.

Including working code examples / snippets and links were appropriate.

Format the output in raw markdown suitable for copy and pasting into vscode.

Check failure on line 15 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L15

[Flanksource.Spelling] Is 'vscode' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'vscode' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 15, "column": 70}}}, "severity": "ERROR"}

Write a blog post on Flanksource MIssion Control approach to AIops, primarily building a real-time and update to mirror state of cloud resources that can be queried rapidly, plus an advanced graph that builds relationships between resources e.g. Cloudformation -> Auto Scaling Group > EC2 instance and then layers on soft relationsyhips like ebs volumes, subnets, IAM poilcies - For Kubernetes it understands Flux and Gitops being able to build a graph of a Flux Kustomization object creating a HelmRelease CRD, which then creates a deployment -> replicset -> pod and then layeying relationships like services, nodes, PVC, ingress, etc..

Check failure on line 17 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L17

[Flanksource.Spelling] Is 'AIops' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'AIops' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 17, "column": 62}}}, "severity": "ERROR"}

Check notice on line 17 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L17

[Flanksource.Passive] 'be queried' looks like passive voice.
Raw output
{"message": "[Flanksource.Passive] 'be queried' looks like passive voice.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 17, "column": 155}}}, "severity": "INFO"}

Check warning on line 17 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L17

[Flanksource.Adverbs] Consider removing 'rapidly'.
Raw output
{"message": "[Flanksource.Adverbs] Consider removing 'rapidly'.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 17, "column": 166}}}, "severity": "WARNING"}

Check failure on line 17 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L17

[Flanksource.Spelling] Is 'Cloudformation' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'Cloudformation' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 17, "column": 247}}}, "severity": "ERROR"}

Check failure on line 17 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L17

[Flanksource.Spelling] Is 'relationsyhips' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'relationsyhips' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 17, "column": 323}}}, "severity": "ERROR"}

Check failure on line 17 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L17

[Flanksource.Spelling] Is 'ebs' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'ebs' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 17, "column": 343}}}, "severity": "ERROR"}

Check failure on line 17 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L17

[Flanksource.Spelling] Is 'subnets' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'subnets' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 17, "column": 356}}}, "severity": "ERROR"}

Check failure on line 17 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L17

[Flanksource.Spelling] Is 'poilcies' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'poilcies' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 17, "column": 369}}}, "severity": "ERROR"}

Check failure on line 17 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L17

[Flanksource.Spelling] Is 'replicset' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'replicset' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 17, "column": 548}}}, "severity": "ERROR"}

Check failure on line 17 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L17

[Flanksource.Spelling] Is 'layeying' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'layeying' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 17, "column": 574}}}, "severity": "ERROR"}

Check notice on line 17 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L17

[Flanksource.Acronyms] 'PVC' has no definition.
Raw output
{"message": "[Flanksource.Acronyms] 'PVC' has no definition.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 17, "column": 619}}}, "severity": "INFO"}

State based alerting (i.e. whene resource self-report failure) and traditioanl alerts from APM tools trigger playbooks that can then proactively collect infomation in a distrubuted fashion from agents deployed closest to the data, the graph, changes to the graph resources, events and pro-acrtive playboks are then fed into the model which tan the recommend futher playbooks to execute.

Check failure on line 19 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L19

[Flanksource.Spelling] Is 'whene' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'whene' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 19, "column": 28}}}, "severity": "ERROR"}

Check failure on line 19 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L19

[Flanksource.Spelling] Is 'traditioanl' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'traditioanl' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 19, "column": 68}}}, "severity": "ERROR"}

Check notice on line 19 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L19

[Flanksource.Acronyms] 'APM' has no definition.
Raw output
{"message": "[Flanksource.Acronyms] 'APM' has no definition.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 19, "column": 92}}}, "severity": "INFO"}

Check failure on line 19 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L19

[Flanksource.Spelling] Is 'infomation' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'infomation' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 19, "column": 154}}}, "severity": "ERROR"}

Check failure on line 19 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L19

[Flanksource.Spelling] Is 'distrubuted' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'distrubuted' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 19, "column": 170}}}, "severity": "ERROR"}

Check failure on line 19 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L19

[Flanksource.Spelling] Is 'playboks' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'playboks' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 19, "column": 298}}}, "severity": "ERROR"}

Check failure on line 19 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L19

[Flanksource.Spelling] Is 'futher' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'futher' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 19, "column": 359}}}, "severity": "ERROR"}
Copy link
Preview

Copilot AI May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are multiple typos in this line: 'whene' should be 'when', 'traditioanl' should be 'traditional', 'infomation' should be 'information', 'distrubuted' should be 'distributed', 'pro-acrtive' should be 'proactive', 'playboks' should be 'playbooks', 'tan' should be 'to', and 'futher' should be 'further'.

Suggested change
State based alerting (i.e. whene resource self-report failure) and traditioanl alerts from APM tools trigger playbooks that can then proactively collect infomation in a distrubuted fashion from agents deployed closest to the data, the graph, changes to the graph resources, events and pro-acrtive playboks are then fed into the model which tan the recommend futher playbooks to execute.
State-based alerting (i.e. when resources self-report failure) and traditional alerts from APM tools trigger playbooks that can then proactively collect information in a distributed fashion from agents deployed closest to the data. The graph, changes to the graph resources, events, and proactive playbooks are then fed into the model, which can then recommend further playbooks to execute.

Copilot uses AI. Check for mistakes.


This is advantage as acess to systems is pushed down to agents who can use secrets like pod identity and service accounts to collect duta, new agent actions are use to create with YAML based playbooks.

Check failure on line 21 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L21

[Flanksource.Spelling] Is 'acess' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'acess' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 21, "column": 22}}}, "severity": "ERROR"}

Check notice on line 21 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L21

[Flanksource.Passive] 'is pushed' looks like passive voice.
Raw output
{"message": "[Flanksource.Passive] 'is pushed' looks like passive voice.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 21, "column": 39}}}, "severity": "INFO"}

Check failure on line 21 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L21

[Flanksource.Spelling] Is 'duta' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'duta' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 21, "column": 134}}}, "severity": "ERROR"}
Copy link
Preview

Copilot AI May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct 'acess' to 'access' and 'duta' to 'data' to improve clarity.

Suggested change
This is advantage as acess to systems is pushed down to agents who can use secrets like pod identity and service accounts to collect duta, new agent actions are use to create with YAML based playbooks.
This is an advantage as access to systems is pushed down to agents who can use secrets like pod identity and service accounts to collect data, new agent actions are used to create YAML-based playbooks.

Copilot uses AI. Check for mistakes.


Write a blog post on the benefits of GitOps and the challenges of adoption - especially with mixed maturity teams (some prefer working in git and others like clickops) - Highlight the mission control approach to gitops (tracking resources and building a graph on how they map to git repository and sources), which enables "editing" kubernetes objects with the changes being submitted back to git. The benefits include a

Check failure on line 23 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L23

[Flanksource.Spelling] Is 'clickops' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'clickops' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 23, "column": 159}}}, "severity": "ERROR"}

Check notice on line 23 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L23

[Flanksource.Passive] 'being submitted' looks like passive voice.
Raw output
{"message": "[Flanksource.Passive] 'being submitted' looks like passive voice.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 23, "column": 369}}}, "severity": "INFO"}

contrasting metrics vs state driven alerting, store with concepts such as RED and USE and how they are more apropriate for monitoring transactions and staady state workloads and fall short for more platform engineering tasks such as monitoring the rollout of a new application or checking if a cluster is healthy after an upgrade. and then use examples of Prometheus and the canary-checker kubernetes check (https://flanksource.com/docs/guide/canary-checker/reference/kubernetes) which used the underlying https://github.com/flanksource/is-healthy library

Check notice on line 25 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L25

[Flanksource.Acronyms] 'RED' has no definition.
Raw output
{"message": "[Flanksource.Acronyms] 'RED' has no definition.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 25, "column": 75}}}, "severity": "INFO"}

Check notice on line 25 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L25

[Flanksource.Acronyms] 'USE' has no definition.
Raw output
{"message": "[Flanksource.Acronyms] 'USE' has no definition.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 25, "column": 83}}}, "severity": "INFO"}

Check failure on line 25 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L25

[Flanksource.Spelling] Is 'apropriate' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'apropriate' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 25, "column": 109}}}, "severity": "ERROR"}

Check failure on line 25 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L25

[Flanksource.Spelling] Is 'staady' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'staady' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 25, "column": 152}}}, "severity": "ERROR"}

Check failure on line 25 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L25

[Flanksource.Spelling] Is 'rollout' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'rollout' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 25, "column": 249}}}, "severity": "ERROR"}
Copy link
Preview

Copilot AI May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct 'apropriate' to 'appropriate' and 'staady' to 'steady'.

Suggested change
contrasting metrics vs state driven alerting, store with concepts such as RED and USE and how they are more apropriate for monitoring transactions and staady state workloads and fall short for more platform engineering tasks such as monitoring the rollout of a new application or checking if a cluster is healthy after an upgrade. and then use examples of Prometheus and the canary-checker kubernetes check (https://flanksource.com/docs/guide/canary-checker/reference/kubernetes) which used the underlying https://github.com/flanksource/is-healthy library
contrasting metrics vs state driven alerting, store with concepts such as RED and USE and how they are more appropriate for monitoring transactions and steady state workloads and fall short for more platform engineering tasks such as monitoring the rollout of a new application or checking if a cluster is healthy after an upgrade. and then use examples of Prometheus and the canary-checker kubernetes check (https://flanksource.com/docs/guide/canary-checker/reference/kubernetes) which used the underlying https://github.com/flanksource/is-healthy library

Copilot uses AI. Check for mistakes.


Highlight the drawbacks of the canary-checker approach that is poll-based and does not scale very well and demononstrate how https://github.com/flanksource/config-db takes this one step further by using a state driven approach that watches for changes to cloud resources, and then fires events when the state becomes unhealthy.

Check warning on line 27 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L27

[Flanksource.Adverbs] Consider removing 'very'.
Raw output
{"message": "[Flanksource.Adverbs] Consider removing 'very'.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 27, "column": 94}}}, "severity": "WARNING"}

Check failure on line 27 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L27

[Flanksource.Spelling] Is 'demononstrate' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'demononstrate' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 27, "column": 108}}}, "severity": "ERROR"}


is more scalable and can be used to monitor the health of a cluster or application in real-time.

Check notice on line 30 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L30

[Flanksource.Passive] 'be used' looks like passive voice.
Raw output
{"message": "[Flanksource.Passive] 'be used' looks like passive voice.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 30, "column": 27}}}, "severity": "INFO"}

Optionally, include {optional elements} (e.g. a strong CTA, technical example, code snippet, customer proof, comparison table).

Check notice on line 32 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L32

[Flanksource.Acronyms] 'CTA' has no definition.
Raw output
{"message": "[Flanksource.Acronyms] 'CTA' has no definition.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 32, "column": 56}}}, "severity": "INFO"}


Act as a technical blog writer targeting devops and platform engineers working with Kubernetes, GitOps, Helm and Flux, when editing and rewriting content follow these instructions strictly:

Check failure on line 35 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L35

[Flanksource.Spelling] Is 'devops' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'devops' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 35, "column": 42}}}, "severity": "ERROR"}

Check warning on line 35 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L35

[Flanksource.Adverbs] Consider removing 'strictly'.
Raw output
{"message": "[Flanksource.Adverbs] Consider removing 'strictly'.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 35, "column": 181}}}, "severity": "WARNING"}

1. Use the following outline for the blog:
* Introduction - introduce the topic of the blog with a pain point or teaser
* Background - Describe the context and initial challenges.
* Step by step guide
* Common Pitfalls - Highlight common mistakes and how to avoid them and add use-cases that are not a good fiit

Check failure on line 41 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L41

[Flanksource.Spelling] Is 'fiit' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'fiit' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 41, "column": 110}}}, "severity": "ERROR"}
* Conclustion - Offer final thoughts and potential future implications.

Check failure on line 42 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L42

[Flanksource.Spelling] Is 'Conclustion' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'Conclustion' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 42, "column": 6}}}, "severity": "ERROR"}
Copy link
Preview

Copilot AI May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct 'Conclustion' to 'Conclusion'.

Suggested change
* Conclustion - Offer final thoughts and potential future implications.
* Conclusion - Offer final thoughts and potential future implications.

Copilot uses AI. Check for mistakes.

2. Write at a Grade 10 level
3. Use clear, concise simple language, even when explaining complex topics.

Check failure on line 44 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L44

[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'simple'.
Raw output
{"message": "[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'simple'.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 44, "column": 23}}}, "severity": "ERROR"}

Check failure on line 44 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L44

[alex.Condescending] Using 'simple' may come across as condescending.
Raw output
{"message": "[alex.Condescending] Using 'simple' may come across as condescending.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 44, "column": 23}}}, "severity": "ERROR"}

Check failure on line 44 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L44

[Flanksource.Condescending] Using 'simple' may come across as condescending.
Raw output
{"message": "[Flanksource.Condescending] Using 'simple' may come across as condescending.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 44, "column": 23}}}, "severity": "ERROR"}
4. Bias toward short sentences.
5. Mix and match lists and paragraphs
6. Do not use any salesy or marketing terms, Do not use adverbs

Check failure on line 47 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L47

[Flanksource.Spelling] Is 'salesy' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'salesy' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 47, "column": 19}}}, "severity": "ERROR"}
7. Use MDX formatting

Check notice on line 48 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L48

[Flanksource.Acronyms] 'MDX' has no definition.
Raw output
{"message": "[Flanksource.Acronyms] 'MDX' has no definition.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 48, "column": 8}}}, "severity": "INFO"}
8. Precede every command with an explanation of what the command does. After the command, provide additional details about the command, such as what the arguments do and why your reader is using them.

Check notice on line 49 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L49

[Flanksource.ComplexWords] Consider using 'give' or 'offer' instead of 'provide'.
Raw output
{"message": "[Flanksource.ComplexWords] Consider using 'give' or 'offer' instead of 'provide'.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 49, "column": 92}}}, "severity": "INFO"}

Check notice on line 49 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L49

[Flanksource.ComplexWords] Consider using 'more' or 'extra' instead of 'additional'.
Raw output
{"message": "[Flanksource.ComplexWords] Consider using 'more' or 'extra' instead of 'additional'.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 49, "column": 100}}}, "severity": "INFO"}
9. Explicitly tell the user to create or open each file you’ll have them use.
10. Like commands, always introduce a file or script by describing its general purpose, then explain any changes that the reader will be making in the file. Without these explanations, readers won’t be able to customize, update, or troubleshoot issues in the long run.

Check warning on line 51 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L51

[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'will'. Say '(event) happens' instead of '(event) will happen'.
Raw output
{"message": "[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'will'. Say '(event) happens' instead of '(event) will happen'.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 51, "column": 130}}}, "severity": "WARNING"}
11. If you’re asking the reader to write code, follow the same approach for commands: introduce the code block with a high-level explanation of what it does. Then show the code, and then call out any important details.
12. Do not use the term "this document", when referring to the system or product being documented always use "Mission Control"

Check notice on line 53 in prompts/blog.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/blog.md#L53

[Flanksource.Passive] 'being documented' looks like passive voice.
Raw output
{"message": "[Flanksource.Passive] 'being documented' looks like passive voice.", "location": {"path": "prompts/blog.md", "range": {"start": {"line": 53, "column": 82}}}, "severity": "INFO"}
13. Ensure all examples and use cases are relevant

56 changes: 56 additions & 0 deletions prompts/style.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Writing Style Guidelines

Follow these strict rules:

1. Avoid adverbs and complex language

## Formating

Check failure on line 7 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L7

[Flanksource.Spelling] Is 'Formating' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'Formating' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/style.md", "range": {"start": {"line": 7, "column": 4}}}, "severity": "ERROR"}
Copy link
Preview

Copilot AI May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the heading from 'Formating' to 'Formatting'.

Suggested change
## Formating
## Formatting

Copilot uses AI. Check for mistakes.

- Format all output using MDX (markdowon)

Check notice on line 8 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L8

[Flanksource.Acronyms] 'MDX' has no definition.
Raw output
{"message": "[Flanksource.Acronyms] 'MDX' has no definition.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 8, "column": 27}}}, "severity": "INFO"}

Check failure on line 8 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L8

[Flanksource.Spelling] Is 'markdowon' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'markdowon' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/style.md", "range": {"start": {"line": 8, "column": 32}}}, "severity": "ERROR"}
Copy link
Preview

Copilot AI May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the typo 'markdowon' to 'markdown'.

Suggested change
- Format all output using MDX (markdowon)
- Format all output using MDX (markdown)

Copilot uses AI. Check for mistakes.

- Format code and examples using this example:

```yaml title=some-title.yaml
```
- Do not remove any "```" or "//highlight-next-line" text
- Follow standard markdown rules provided by markdownlint

Check failure on line 14 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L14

[Flanksource.Spelling] Is 'markdownlint' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'markdownlint' spelled correctly? Is it missing code formatting?", "location": {"path": "prompts/style.md", "range": {"start": {"line": 14, "column": 46}}}, "severity": "ERROR"}


## Verb Tense
- Use present tense verbs instead of future tense.
- Say "this happens" rather than "this will happen."

Check warning on line 19 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L19

[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'will'. Say '(event) happens' instead of '(event) will happen'.
Raw output
{"message": "[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'will'. Say '(event) happens' instead of '(event) will happen'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 19, "column": 40}}}, "severity": "WARNING"}
- Avoid words like "will," "shall," "won't," "shan't," and contractions with "'ll."

Check warning on line 20 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L20

[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'will'. Say '(event) happens' instead of '(event) will happen'.
Raw output
{"message": "[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'will'. Say '(event) happens' instead of '(event) will happen'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 20, "column": 21}}}, "severity": "WARNING"}

Check warning on line 20 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L20

[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'shall'. Say '(event) happens' instead of '(event) will happen'.
Raw output
{"message": "[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'shall'. Say '(event) happens' instead of '(event) will happen'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 20, "column": 29}}}, "severity": "WARNING"}

Check warning on line 20 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L20

[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'won't'. Say '(event) happens' instead of '(event) will happen'.
Raw output
{"message": "[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'won't'. Say '(event) happens' instead of '(event) will happen'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 20, "column": 38}}}, "severity": "WARNING"}

Check warning on line 20 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L20

[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'shan't'. Say '(event) happens' instead of '(event) will happen'.
Raw output
{"message": "[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'shan't'. Say '(event) happens' instead of '(event) will happen'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 20, "column": 47}}}, "severity": "WARNING"}

## Voice
- Do not use first person (I, me, my, mine, we, our).

Check failure on line 23 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L23

[Flanksource.FirstPerson] Do not use the first person (such as 'me').
Raw output
{"message": "[Flanksource.FirstPerson] Do not use the first person (such as 'me').", "location": {"path": "prompts/style.md", "range": {"start": {"line": 23, "column": 31}}}, "severity": "ERROR"}

Check failure on line 23 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L23

[Flanksource.FirstPerson] Do not use the first person (such as 'my').
Raw output
{"message": "[Flanksource.FirstPerson] Do not use the first person (such as 'my').", "location": {"path": "prompts/style.md", "range": {"start": {"line": 23, "column": 35}}}, "severity": "ERROR"}

Check failure on line 23 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L23

[Flanksource.FirstPerson] Do not use the first person (such as 'mine').
Raw output
{"message": "[Flanksource.FirstPerson] Do not use the first person (such as 'mine').", "location": {"path": "prompts/style.md", "range": {"start": {"line": 23, "column": 39}}}, "severity": "ERROR"}
- Avoid phrases like "I'd," "I'll," "I'm," and "I've."

Check failure on line 24 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L24

[Flanksource.FirstPerson] Do not use the first person (such as 'I'd').
Raw output
{"message": "[Flanksource.FirstPerson] Do not use the first person (such as 'I'd').", "location": {"path": "prompts/style.md", "range": {"start": {"line": 24, "column": 23}}}, "severity": "ERROR"}

Check failure on line 24 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L24

[Flanksource.FirstPerson] Do not use the first person (such as 'I'll').
Raw output
{"message": "[Flanksource.FirstPerson] Do not use the first person (such as 'I'll').", "location": {"path": "prompts/style.md", "range": {"start": {"line": 24, "column": 30}}}, "severity": "ERROR"}

Check warning on line 24 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L24

[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'I'll'. Say '(event) happens' instead of '(event) will happen'.
Raw output
{"message": "[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'I'll'. Say '(event) happens' instead of '(event) will happen'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 24, "column": 30}}}, "severity": "WARNING"}

Check failure on line 24 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L24

[Flanksource.FirstPerson] Do not use the first person (such as 'I'm').
Raw output
{"message": "[Flanksource.FirstPerson] Do not use the first person (such as 'I'm').", "location": {"path": "prompts/style.md", "range": {"start": {"line": 24, "column": 38}}}, "severity": "ERROR"}

Check failure on line 24 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L24

[Flanksource.FirstPerson] Do not use the first person (such as 'I've').
Raw output
{"message": "[Flanksource.FirstPerson] Do not use the first person (such as 'I've').", "location": {"path": "prompts/style.md", "range": {"start": {"line": 24, "column": 49}}}, "severity": "ERROR"}
- Use passive voice sparingly. Active voice is generally clearer.

Check warning on line 25 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L25

[Flanksource.Adverbs] Consider removing 'generally'.
Raw output
{"message": "[Flanksource.Adverbs] Consider removing 'generally'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 25, "column": 48}}}, "severity": "WARNING"}

## Inclusive Language
- Use considerate language that respects all readers.
- Use "they" as a singular pronoun instead of "he/she" or "s/he."

Check failure on line 29 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L29

[Flanksource.SingularThey] Use singular 'they' instead of 'he/she'.
Raw output
{"message": "[Flanksource.SingularThey] Use singular 'they' instead of 'he/she'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 29, "column": 48}}}, "severity": "ERROR"}

Check failure on line 29 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L29

[Flanksource.SingularThey] Use singular 'they' instead of 's/he'.
Raw output
{"message": "[Flanksource.SingularThey] Use singular 'they' instead of 's/he'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 29, "column": 60}}}, "severity": "ERROR"}
- Avoid terms that might be insensitive:
- Replace "sane" with "correct," "adequate," "sensible," etc.

Check warning on line 31 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L31

[Flanksource.Ablist] When referring to a person, consider using 'correct', 'adequate', 'sufficient', 'consistent', 'valid', 'coherent', 'sensible', or 'reasonable' instead of 'sane'.
Raw output
{"message": "[Flanksource.Ablist] When referring to a person, consider using 'correct', 'adequate', 'sufficient', 'consistent', 'valid', 'coherent', 'sensible', or 'reasonable' instead of 'sane'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 31, "column": 14}}}, "severity": "WARNING"}

Check warning on line 31 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L31

[Flanksource.ConsiderateWriting] Consider using 'correct', 'adequate', 'sufficient', 'consistent', 'valid', 'coherent', 'sensible', or 'reasonable' instead of 'sane'.
Raw output
{"message": "[Flanksource.ConsiderateWriting] Consider using 'correct', 'adequate', 'sufficient', 'consistent', 'valid', 'coherent', 'sensible', or 'reasonable' instead of 'sane'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 31, "column": 14}}}, "severity": "WARNING"}
- Replace "crazy/insane" with "extremely," "very," "illogical," etc.

Check warning on line 32 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L32

[Flanksource.Ablist] When referring to a person, consider using 'rude', 'malicious', 'mean', 'disgusting', 'incredible', 'vile', 'person with symptoms of mental illness', 'person with mental illness', 'person with symptoms of a mental disorder', or 'person with a mental disorder' instead of 'crazy'.
Raw output
{"message": "[Flanksource.Ablist] When referring to a person, consider using 'rude', 'malicious', 'mean', 'disgusting', 'incredible', 'vile', 'person with symptoms of mental illness', 'person with mental illness', 'person with symptoms of a mental disorder', or 'person with a mental disorder' instead of 'crazy'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 32, "column": 14}}}, "severity": "WARNING"}

Check warning on line 32 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L32

[Flanksource.ConsiderateWriting] Consider using 'extremely', 'very', 'illogical', or 'unreasonable' instead of 'crazy'.
Raw output
{"message": "[Flanksource.ConsiderateWriting] Consider using 'extremely', 'very', 'illogical', or 'unreasonable' instead of 'crazy'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 32, "column": 14}}}, "severity": "WARNING"}

Check warning on line 32 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L32

[Flanksource.Ablist] When referring to a person, consider using 'rude', 'malicious', 'mean', 'disgusting', 'incredible', 'vile', 'person with symptoms of mental illness', 'person with mental illness', 'person with symptoms of a mental disorder', or 'person with a mental disorder' instead of 'insane'.
Raw output
{"message": "[Flanksource.Ablist] When referring to a person, consider using 'rude', 'malicious', 'mean', 'disgusting', 'incredible', 'vile', 'person with symptoms of mental illness', 'person with mental illness', 'person with symptoms of a mental disorder', or 'person with a mental disorder' instead of 'insane'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 32, "column": 20}}}, "severity": "WARNING"}

Check warning on line 32 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L32

[Flanksource.ConsiderateWriting] Consider using 'extremely', 'very', 'illogical', or 'unreasonable' instead of 'insane'.
Raw output
{"message": "[Flanksource.ConsiderateWriting] Consider using 'extremely', 'very', 'illogical', or 'unreasonable' instead of 'insane'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 32, "column": 20}}}, "severity": "WARNING"}

Check warning on line 32 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L32

[Flanksource.Adverbs] Consider removing 'extremely'.
Raw output
{"message": "[Flanksource.Adverbs] Consider removing 'extremely'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 32, "column": 34}}}, "severity": "WARNING"}

Check warning on line 32 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L32

[Flanksource.Adverbs] Consider removing 'very'.
Raw output
{"message": "[Flanksource.Adverbs] Consider removing 'very'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 32, "column": 47}}}, "severity": "WARNING"}
- Replace "dummy" with "placeholder" or "test"

Check warning on line 33 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L33

[Flanksource.Ablist] When referring to a person, consider using 'test double', 'placeholder', 'fake', or 'stub' instead of 'dummy'.
Raw output
{"message": "[Flanksource.Ablist] When referring to a person, consider using 'test double', 'placeholder', 'fake', or 'stub' instead of 'dummy'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 33, "column": 14}}}, "severity": "WARNING"}

Check warning on line 33 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L33

[Flanksource.ConsiderateWriting] Consider using 'placeholder', 'stand-in', or 'test' instead of 'dummy'.
Raw output
{"message": "[Flanksource.ConsiderateWriting] Consider using 'placeholder', 'stand-in', or 'test' instead of 'dummy'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 33, "column": 14}}}, "severity": "WARNING"}
- Replace "hang" with "freeze" or "become unresponsive"

Check warning on line 34 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L34

[alex.Suicide] Consider using 'the app froze', 'the app stopped responding', 'the app stopped responding to events', or 'the app became unresponsive' instead of 'hang' (which may be insensitive).
Raw output
{"message": "[alex.Suicide] Consider using 'the app froze', 'the app stopped responding', 'the app stopped responding to events', or 'the app became unresponsive' instead of 'hang' (which may be insensitive).", "location": {"path": "prompts/style.md", "range": {"start": {"line": 34, "column": 14}}}, "severity": "WARNING"}

Check warning on line 34 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L34

[Flanksource.ConsiderateWriting] Consider using 'freeze', 'stop responding', or 'become unresponsive' instead of 'hang'.
Raw output
{"message": "[Flanksource.ConsiderateWriting] Consider using 'freeze', 'stop responding', or 'become unresponsive' instead of 'hang'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 34, "column": 14}}}, "severity": "WARNING"}
- Avoid phrases like "fall on deaf ears" or "blind spot"

Check warning on line 35 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L35

[Flanksource.ConsiderateWriting] Consider using 'missed the mark' or 'was ignored' instead of 'fall on deaf ears'.
Raw output
{"message": "[Flanksource.ConsiderateWriting] Consider using 'missed the mark' or 'was ignored' instead of 'fall on deaf ears'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 35, "column": 25}}}, "severity": "WARNING"}

Check warning on line 35 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L35

[Flanksource.ProfanityUnlikely] Be careful with 'blind', it's profane in some cases.
Raw output
{"message": "[Flanksource.ProfanityUnlikely] Be careful with 'blind', it's profane in some cases.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 35, "column": 48}}}, "severity": "WARNING"}

Check warning on line 35 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L35

[Flanksource.ConsiderateWriting] Consider using 'weakness' or 'something we overlooked' instead of 'blind spot'.
Raw output
{"message": "[Flanksource.ConsiderateWriting] Consider using 'weakness' or 'something we overlooked' instead of 'blind spot'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 35, "column": 48}}}, "severity": "WARNING"}

## Tone
- Don't assume success with statements like "congratulations," "that's it," or "you did it."

Check failure on line 38 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L38

[Flanksource.AssumeSuccess] Don't assume success with statements like 'congratulations'.
Raw output
{"message": "[Flanksource.AssumeSuccess] Don't assume success with statements like 'congratulations'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 38, "column": 46}}}, "severity": "ERROR"}

Check failure on line 38 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L38

[Flanksource.AssumeSuccess] Don't assume success with statements like 'that's it'.
Raw output
{"message": "[Flanksource.AssumeSuccess] Don't assume success with statements like 'that's it'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 38, "column": 65}}}, "severity": "ERROR"}

Check failure on line 38 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L38

[Flanksource.AssumeSuccess] Don't assume success with statements like 'you did it'.
Raw output
{"message": "[Flanksource.AssumeSuccess] Don't assume success with statements like 'you did it'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 38, "column": 81}}}, "severity": "ERROR"}
- Avoid condescending terms like "obvious," "obviously," "simple," "simply," "easy," "easily," "of course," "clearly," or "everyone knows."

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'obvious'.
Raw output
{"message": "[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'obvious'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 35}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[alex.Condescending] Using 'obvious' may come across as condescending.
Raw output
{"message": "[alex.Condescending] Using 'obvious' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 35}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.Condescending] Using 'obvious' may come across as condescending.
Raw output
{"message": "[Flanksource.Condescending] Using 'obvious' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 35}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'obviously'.
Raw output
{"message": "[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'obviously'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 46}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.Condescending] Using 'obviously' may come across as condescending.
Raw output
{"message": "[Flanksource.Condescending] Using 'obviously' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 46}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[alex.Condescending] Using 'obviously' may come across as condescending.
Raw output
{"message": "[alex.Condescending] Using 'obviously' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 46}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'simple'.
Raw output
{"message": "[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'simple'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 59}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.Condescending] Using 'simple' may come across as condescending.
Raw output
{"message": "[Flanksource.Condescending] Using 'simple' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 59}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[alex.Condescending] Using 'simple' may come across as condescending.
Raw output
{"message": "[alex.Condescending] Using 'simple' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 59}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'simply'.
Raw output
{"message": "[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'simply'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 69}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.Condescending] Using 'simply' may come across as condescending.
Raw output
{"message": "[Flanksource.Condescending] Using 'simply' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 69}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[alex.Condescending] Using 'simply' may come across as condescending.
Raw output
{"message": "[alex.Condescending] Using 'simply' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 69}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.Condescending] Using 'easy' may come across as condescending.
Raw output
{"message": "[Flanksource.Condescending] Using 'easy' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 79}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[alex.Condescending] Using 'easy' may come across as condescending.
Raw output
{"message": "[alex.Condescending] Using 'easy' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 79}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'easy'.
Raw output
{"message": "[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'easy'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 79}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'easily'.
Raw output
{"message": "[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'easily'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 87}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.Condescending] Using 'easily' may come across as condescending.
Raw output
{"message": "[Flanksource.Condescending] Using 'easily' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 87}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[alex.Condescending] Using 'easily' may come across as condescending.
Raw output
{"message": "[alex.Condescending] Using 'easily' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 87}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[alex.Condescending] Using 'of course' may come across as condescending.
Raw output
{"message": "[alex.Condescending] Using 'of course' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 97}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'of course'.
Raw output
{"message": "[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'of course'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 97}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.Condescending] Using 'of course' may come across as condescending.
Raw output
{"message": "[Flanksource.Condescending] Using 'of course' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 97}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.Condescending] Using 'clearly' may come across as condescending.
Raw output
{"message": "[Flanksource.Condescending] Using 'clearly' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 110}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[alex.Condescending] Using 'clearly' may come across as condescending.
Raw output
{"message": "[alex.Condescending] Using 'clearly' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 110}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'clearly'.
Raw output
{"message": "[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'clearly'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 110}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[alex.Condescending] Using 'everyone knows' may come across as condescending.
Raw output
{"message": "[alex.Condescending] Using 'everyone knows' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 124}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'everyone knows'.
Raw output
{"message": "[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'everyone knows'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 124}}}, "severity": "ERROR"}

Check failure on line 39 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L39

[Flanksource.Condescending] Using 'everyone knows' may come across as condescending.
Raw output
{"message": "[Flanksource.Condescending] Using 'everyone knows' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 39, "column": 124}}}, "severity": "ERROR"}
- Don't add "-ly" to ordinal numbers (avoid "firstly," "secondly," etc.)

Check failure on line 40 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L40

[Flanksource.OrdinalLy] Don't add -ly to an ordinal number.
Raw output
{"message": "[Flanksource.OrdinalLy] Don't add -ly to an ordinal number.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 40, "column": 46}}}, "severity": "ERROR"}

Check failure on line 40 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L40

[Flanksource.OrdinalLy] Don't add -ly to an ordinal number.
Raw output
{"message": "[Flanksource.OrdinalLy] Don't add -ly to an ordinal number.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 40, "column": 57}}}, "severity": "ERROR"}

## Clarity and Brevity
- Use simple words instead of complex ones.

Check failure on line 43 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L43

[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'simple'.
Raw output
{"message": "[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'simple'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 43, "column": 7}}}, "severity": "ERROR"}

Check failure on line 43 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L43

[alex.Condescending] Using 'simple' may come across as condescending.
Raw output
{"message": "[alex.Condescending] Using 'simple' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 43, "column": 7}}}, "severity": "ERROR"}

Check failure on line 43 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L43

[Flanksource.Condescending] Using 'simple' may come across as condescending.
Raw output
{"message": "[Flanksource.Condescending] Using 'simple' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 43, "column": 7}}}, "severity": "ERROR"}
- Avoid foreign phrases like "i.e.," "viz.," or "ergo."

Check failure on line 44 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L44

[Flanksource.Foreign] Use 'namely' instead of 'viz.,'.
Raw output
{"message": "[Flanksource.Foreign] Use 'namely' instead of 'viz.,'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 44, "column": 39}}}, "severity": "ERROR"}
- Eliminate wordiness and redundant phrases:

Check notice on line 45 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L45

[Flanksource.ComplexWords] Consider using 'end' instead of 'Eliminate'.
Raw output
{"message": "[Flanksource.ComplexWords] Consider using 'end' instead of 'Eliminate'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 45, "column": 3}}}, "severity": "INFO"}
- "in order to" → "to"

Check warning on line 46 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L46

[Flanksource.Wordiness] Consider using 'to' instead of 'in order to'.
Raw output
{"message": "[Flanksource.Wordiness] Consider using 'to' instead of 'in order to'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 46, "column": 6}}}, "severity": "WARNING"}
- "due to the fact that" → "because"

Check warning on line 47 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L47

[Flanksource.Wordiness] Consider using 'because' instead of 'due to the fact that'.
Raw output
{"message": "[Flanksource.Wordiness] Consider using 'because' instead of 'due to the fact that'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 47, "column": 6}}}, "severity": "WARNING"}
- "at this point in time" → "now"

Check warning on line 48 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L48

[Flanksource.Wordiness] Consider using 'at this point' instead of 'at this point in time'.
Raw output
{"message": "[Flanksource.Wordiness] Consider using 'at this point' instead of 'at this point in time'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 48, "column": 6}}}, "severity": "WARNING"}

Check failure on line 48 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L48

[Flanksource.Cliches] 'this point in time' is a cliche.
Raw output
{"message": "[Flanksource.Cliches] 'this point in time' is a cliche.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 48, "column": 9}}}, "severity": "ERROR"}
- "in the event that" → "if"

Check warning on line 49 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L49

[Flanksource.Wordiness] Consider using 'if' instead of 'in the event that'.
Raw output
{"message": "[Flanksource.Wordiness] Consider using 'if' instead of 'in the event that'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 49, "column": 6}}}, "severity": "WARNING"}
- Remove phrases that don't add clarity:
- "note that"

Check failure on line 51 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L51

[Flanksource.Brevity] Avoid statements that don't add clarity, like 'note that'.
Raw output
{"message": "[Flanksource.Brevity] Avoid statements that don't add clarity, like 'note that'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 51, "column": 6}}}, "severity": "ERROR"}
- "it is important to note"

Check failure on line 52 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L52

[Flanksource.Brevity] Avoid statements that don't add clarity, like 'it is important to note'.
Raw output
{"message": "[Flanksource.Brevity] Avoid statements that don't add clarity, like 'it is important to note'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 52, "column": 6}}}, "severity": "ERROR"}
- "keep in mind"
- "as you can see"

Check failure on line 54 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L54

[Flanksource.Brevity] Avoid statements that don't add clarity, like 'as you can see'.
Raw output
{"message": "[Flanksource.Brevity] Avoid statements that don't add clarity, like 'as you can see'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 54, "column": 6}}}, "severity": "ERROR"}

Remember that clear, direct language helps readers understand your content more easily.

Check failure on line 56 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L56

[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'easily'.
Raw output
{"message": "[Flanksource.DictateFeelings] Don't tell people how they feel with words like 'easily'.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 56, "column": 81}}}, "severity": "ERROR"}

Check failure on line 56 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L56

[alex.Condescending] Using 'easily' may come across as condescending.
Raw output
{"message": "[alex.Condescending] Using 'easily' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 56, "column": 81}}}, "severity": "ERROR"}

Check failure on line 56 in prompts/style.md

View workflow job for this annotation

GitHub Actions / vale

[vale] prompts/style.md#L56

[Flanksource.Condescending] Using 'easily' may come across as condescending.
Raw output
{"message": "[Flanksource.Condescending] Using 'easily' may come across as condescending.", "location": {"path": "prompts/style.md", "range": {"start": {"line": 56, "column": 81}}}, "severity": "ERROR"}
41 changes: 26 additions & 15 deletions styles/Flanksource/Acronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,24 @@ exceptions:
- CRUD
- CSS
- CSV
- RDS
- SQS
- Subnet
- IAMRole
- ECSTask
- ECSCluster
- EBSVolume
- EBSVolume
- DNSZone
- DEBUG
- DHCP
- ECS
- DNS
- EKS
- IAM
- IRSA
- VPC
- DEBUG
- DNSZone
- DOM
- DPI
- EBS
- EBSVolume
- ECR
- ECS
- ECSCluster
- ECSService
- ECSTask
- ECSTask
Copy link
Preview

Copilot AI May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The acronym 'ECSTask' appears more than once; please remove duplicate entries to keep the list concise.

Suggested change
- ECSTask

Copilot uses AI. Check for mistakes.

- EFS
- EKS
- EKSCluster
- EKSCluster
- FAQ
- GCC
Comment on lines +39 to 41
Copy link
Preview

Copilot AI May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The acronym 'EKSCluster' is duplicated; consider removing one instance to prevent redundancy.

Suggested change
- EKSCluster
- FAQ
- GCC
- FAQ
- GCC
- GCC

Copilot uses AI. Check for mistakes.

- GDB
Expand All @@ -48,7 +47,11 @@ exceptions:
- HTML
- HTTP
- HTTPS
- IAM
- IAMRole
- IAMUser
- IDE
- IRSA
- JAR
- JPG
- JSON
Expand All @@ -65,14 +68,21 @@ exceptions:
- POST
- RAM
- RBAC
- RDS
- RDSInstance
- REPL
- RSA
- SCM
- SCSS
- SDK
- SNS
- SNSTopic
- SQL
- SQS
- SQSQueue
- SSH
- SSL
- Subnet
- SVG
- TBD
- TCP
Expand All @@ -82,6 +92,7 @@ exceptions:
- USB
- UTF
- UUID
- VPC
- XML
- XSS
- YAML
Expand Down
8 changes: 1 addition & 7 deletions styles/Flanksource/CaseSensitiveSpellingSuggestions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,4 @@ level: error
action:
name: replace
swap:
"[Ii]ngress.NGINX": Ingress-NGINX
".ngress.[Nn]ginx": Ingress-NGINX
"[Nn]ginx [Ii]ngress [Cc]ontroller": NGINX Ingress Controller
"NGINX ingress [Cc]ontroller": NGINX Ingress Controller
"NGINX [Ii]ngress controller": NGINX Ingress Controller
"(?<!Ingress-)(?:Nginx|NGINX)(?! Ingress)": nginx
"(?<!Ingress-)(?:Nginx|NGINX)'s(?! Ingress)": nginx's
"[Nn]ginx": "nginx"
Copy link
Preview

Copilot AI May 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Verify that the new mapping for '[Nn]ginx' is consistent with existing rules and desired capitalization outcomes.

Suggested change
"[Nn]ginx": "nginx"
"[Nn]ginx": "Nginx"

Copilot uses AI. Check for mistakes.

1 change: 0 additions & 1 deletion styles/Flanksource/ComplexWords.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ swap:
collaborate: work together
commence: begin
compensate: pay
component: part
comprise: form|include
concerning: about
confer: give|award
Expand Down
Loading