From 679c181db1723c73f760fe61b8fe7418df7151a9 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 22 Dec 2022 09:55:54 -0500 Subject: [PATCH 1/6] chore: Ignore local reference and ignore eslint Signed-off-by: Adam Harvey --- scripts/check-docs-quality.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/scripts/check-docs-quality.js b/scripts/check-docs-quality.js index ac9db65b40..9c7f444033 100755 --- a/scripts/check-docs-quality.js +++ b/scripts/check-docs-quality.js @@ -23,6 +23,7 @@ const IGNORED = [ /^.*[/\\]CHANGELOG\.md$/, /^.*[/\\]api-report\.md$/, /^docs[/\\]releases[/\\].*-changelog\.md$/, + /^docs[/\\]reference[/\\]/, ]; const rootDir = resolvePath(__dirname, '..'); @@ -55,6 +56,7 @@ async function listFiles(dir = '') { // caused by the script. In CI, we want to ensure vale linter is run. async function exitIfMissingVale() { try { + // eslint-disable-next-line import/no-extraneous-dependencies await require('command-exists')('vale'); } catch (e) { if (process.env.CI) { @@ -72,7 +74,7 @@ async function exitIfMissingVale() { async function runVale(files) { const result = spawnSync( 'vale', - ['--config', resolvePath(rootDir, '.github/vale/config.ini'), ...files], + ['--config', resolvePath(rootDir, '.vale.ini'), ...files], { stdio: 'inherit', }, From 82996901dca5b1e5f76dd84265cf7ec31a4cafa7 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 22 Dec 2022 09:56:37 -0500 Subject: [PATCH 2/6] chore: Refactor Vale config to better support local editing Signed-off-by: Adam Harvey --- .github/{vale => vale-styles}/Vocab/Backstage/accept.txt | 2 +- .github/vale/config.ini | 6 ------ .vale.ini | 5 ++++- 3 files changed, 5 insertions(+), 8 deletions(-) rename .github/{vale => vale-styles}/Vocab/Backstage/accept.txt (99%) delete mode 100644 .github/vale/config.ini diff --git a/.github/vale/Vocab/Backstage/accept.txt b/.github/vale-styles/Vocab/Backstage/accept.txt similarity index 99% rename from .github/vale/Vocab/Backstage/accept.txt rename to .github/vale-styles/Vocab/Backstage/accept.txt index bba59094e3..dd64ea849c 100644 --- a/.github/vale/Vocab/Backstage/accept.txt +++ b/.github/vale-styles/Vocab/Backstage/accept.txt @@ -316,7 +316,7 @@ sparklines Splunk Spotifiers spotify -Spotify +# Spotify sqlite sqs squidfunk diff --git a/.github/vale/config.ini b/.github/vale/config.ini deleted file mode 100644 index 36acb2c058..0000000000 --- a/.github/vale/config.ini +++ /dev/null @@ -1,6 +0,0 @@ -StylesPath = . -Vocab = Backstage - -[*.md] -BasedOnStyles = Vale -Vale.Terms = NO diff --git a/.vale.ini b/.vale.ini index fd1ea53b0d..4975a81f28 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,7 @@ -StylesPath = .github/styles +StylesPath = .github/vale-styles + +Vocab = Backstage [*.md] BasedOnStyles = Vale +Vale.Terms = NO From 95c2c9430e471fd32b917d5bef555897d0a2a0cb Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 22 Dec 2022 10:16:24 -0500 Subject: [PATCH 3/6] fix: Return company proper case Signed-off-by: Adam Harvey --- .github/vale-styles/Vocab/Backstage/accept.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/vale-styles/Vocab/Backstage/accept.txt b/.github/vale-styles/Vocab/Backstage/accept.txt index dd64ea849c..bba59094e3 100644 --- a/.github/vale-styles/Vocab/Backstage/accept.txt +++ b/.github/vale-styles/Vocab/Backstage/accept.txt @@ -316,7 +316,7 @@ sparklines Splunk Spotifiers spotify -# Spotify +Spotify sqlite sqs squidfunk From ad490c7115ad73f1536eb0a8e110db44d0f7deae Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 22 Dec 2022 10:33:32 -0500 Subject: [PATCH 4/6] fix: Return original folder name Signed-off-by: Adam Harvey --- .../vale-styles/Vocab/Backstage/accept.txt | 416 ------------------ .vale.ini | 2 +- 2 files changed, 1 insertion(+), 417 deletions(-) delete mode 100644 .github/vale-styles/Vocab/Backstage/accept.txt diff --git a/.github/vale-styles/Vocab/Backstage/accept.txt b/.github/vale-styles/Vocab/Backstage/accept.txt deleted file mode 100644 index 20e1c867a7..0000000000 --- a/.github/vale-styles/Vocab/Backstage/accept.txt +++ /dev/null @@ -1,416 +0,0 @@ -abc -accessors -ACLs -addon -addons -ADRs -airbrake -Airbrake -Airbrakes -Alaria -Alef -Anddddd -Apdex -api -asciidoc -async -Atlassian -automations -autoscaling -Autoscaling -autoselect -Avro -backend's -backported -backporting -Bigtable -Billett -bitbucket -Bitrise -Blackbox -bool -boolean -Brex -builtins -callout -CDNs -Chai -changeset -changesets -Changesets -chanwit -Chanwit -CI/CD -classname -cli -cloudbuild -Cloudflare -Cloudformation -cncf -Cobertura -codeblocks -Codecov -codehilite -Codehilite -codemod -codemods -codeowners -codescene -CodeScene -composability -composable -config -Config -configmaps -configs -const -cookiecutter -Corti -cron -cronjobs -crontab -css -Datadog -dataflow -dayjs -debounce -Debounce -debuggability -declaratively -deduplicated -dependabot -deps -destructured -destructuring -dev -devops -devs -discoverability -Discoverability -dls -Dockerfile -dockerfiles -Dockerize -dockerode -Docusaurus -DOMPurify -don'ts -dynatrace -Dynatrace -ecco -elasticsearch -env -Env -esbuild -eslint -ESModule -ESModules -etag -Expedia -facto -failover -Fargate -Figma -firehydrant -FireHydrant -Firekube -Firestore -Fiverr -Francesco -gerrit -Gerrit -gitbeaker -gitea -Gitea -github -Gitiles -gitlab -GitLab -globals -Gource -Grafana -graphql -GraphQL -graphviz -Hackathons -haproxy -hardcoded -Helidon -Heroku -hoc -horizontalpodautoscalers -Hostname -hotspots -http -https -Iain -Iglesias -iLert -img -incentivised -Indal -indexable -inlined -inlinehilite -integrator's -interop -JaCoCo -JavaScript -jenkins -Jira -jq -js -json -jsonnet -jsx -JWTs -Kaewkasi -Keyv -Knex -KPIs -kubectl -kubernetes -kubernetes -ldap -learnings -Leasot -lerna -Lerna -LocalStack -lockdown -lockfile -lunr -Luxon -magiclink -mailto -maintainer's -maintainership -makefile -md -memcache -memoize -memoized -microservice -microservices -microsite -microtasks -middleware -minikube -Minikube -Minio -misconfiguration -misconfigured -mkdocs -Mkdocs -monorepo -Monorepo -monorepos -msgraph -msw -mutex -mutexes -mysql -namespace -namespaced -namespaces -Namespaces -namespacing -neuro -newrelic -nginx -nodegit -nohoist -nonces -noop -npm -nunjucks -nvarchar -nvm -OAuth -octokit -oidc -Okta -Oldsberg -onboarding -Onboarding -OpenShift -orgs -padding -paddings -pagerduty -pageview -parallelization -parseable -Patrik -pattison -Peloton -performant -Performant -periskop -Periskop -permissioned -permissioning -plantuml -Platformize -Podman -postgres -postpack -pre -prebaked -preconfigured -prepack -Preprarer -productional -Protobuf -proxying -Proxying -pseudonymized -pubsub -pygments -pymdownx -rankdir -readme -Readme -readonly -rebase -Recharts -Redash -replicasets -repo -Repo -repos -rerender -rerenders -reusability -Reusability -roadmaps -rollbar -Rollbar -Rollup -routable -Routable -rst -rsync -ruleset -runbook -sam -sanitization -scaffolded -scaffolder -Scaffolder -scrollbar -seb -semlas -semver -serializable -Serverless -shoutout -SIG -SIGs -siloed -Sinon -Snyk -Sonarqube -sourcemaps -sparklines -Splunk -Spotifiers -spotify -Spotify -sqlite -sqs -squidfunk -src -statefulsets -stdout -storable -stringified -stringify -subcomponent -subcomponents -subfolder -subfolders -subheader -subheaders -subkey -subroutes -subtree -superfences -Superfences -superset -supertype -SVGs -talkdesk -Talkdesk -Tanzu -tasklist -techdocs -Telenor -telus -templated -templater -Templater -templaters -Templaters -TFRecord -theia -thumbsup -todo -todos -togglable -tolerations -Tolerations -toolchain -toolsets -tooltip -tooltips -touchpoint -transpilation -transpiled -transpiler -transpilers -truthy -TSDoc -typeahead -ui -unbreak -Unconference -unmanaged -unregister -unregistering -unregistration -untracked -upsert -upvote -URIs -URLs -utils -Valentina -validator -validators -varchar -VMware -VPCs -VSCode -Wayfair -Weaveworks -Webpack -widget's -winston -www -WWW -XCMetrics -XML -xyz -yaml -Zalando -Zhou -zod -Zolotusky -zoomable -zsh -Lainfiesta -allowlisted -Dominik -Henneke -Kuang diff --git a/.vale.ini b/.vale.ini index 4975a81f28..fa7864a878 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,4 @@ -StylesPath = .github/vale-styles +StylesPath = .github/vale Vocab = Backstage From b3484d436871a33588718cdf0aa691f298ed824b Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 22 Dec 2022 11:07:38 -0500 Subject: [PATCH 5/6] fix: Missed the renamed file Signed-off-by: Adam Harvey --- .github/vale/Vocab/Backstage/accept.txt | 416 ++++++++++++++++++++++++ 1 file changed, 416 insertions(+) create mode 100644 .github/vale/Vocab/Backstage/accept.txt diff --git a/.github/vale/Vocab/Backstage/accept.txt b/.github/vale/Vocab/Backstage/accept.txt new file mode 100644 index 0000000000..20e1c867a7 --- /dev/null +++ b/.github/vale/Vocab/Backstage/accept.txt @@ -0,0 +1,416 @@ +abc +accessors +ACLs +addon +addons +ADRs +airbrake +Airbrake +Airbrakes +Alaria +Alef +Anddddd +Apdex +api +asciidoc +async +Atlassian +automations +autoscaling +Autoscaling +autoselect +Avro +backend's +backported +backporting +Bigtable +Billett +bitbucket +Bitrise +Blackbox +bool +boolean +Brex +builtins +callout +CDNs +Chai +changeset +changesets +Changesets +chanwit +Chanwit +CI/CD +classname +cli +cloudbuild +Cloudflare +Cloudformation +cncf +Cobertura +codeblocks +Codecov +codehilite +Codehilite +codemod +codemods +codeowners +codescene +CodeScene +composability +composable +config +Config +configmaps +configs +const +cookiecutter +Corti +cron +cronjobs +crontab +css +Datadog +dataflow +dayjs +debounce +Debounce +debuggability +declaratively +deduplicated +dependabot +deps +destructured +destructuring +dev +devops +devs +discoverability +Discoverability +dls +Dockerfile +dockerfiles +Dockerize +dockerode +Docusaurus +DOMPurify +don'ts +dynatrace +Dynatrace +ecco +elasticsearch +env +Env +esbuild +eslint +ESModule +ESModules +etag +Expedia +facto +failover +Fargate +Figma +firehydrant +FireHydrant +Firekube +Firestore +Fiverr +Francesco +gerrit +Gerrit +gitbeaker +gitea +Gitea +github +Gitiles +gitlab +GitLab +globals +Gource +Grafana +graphql +GraphQL +graphviz +Hackathons +haproxy +hardcoded +Helidon +Heroku +hoc +horizontalpodautoscalers +Hostname +hotspots +http +https +Iain +Iglesias +iLert +img +incentivised +Indal +indexable +inlined +inlinehilite +integrator's +interop +JaCoCo +JavaScript +jenkins +Jira +jq +js +json +jsonnet +jsx +JWTs +Kaewkasi +Keyv +Knex +KPIs +kubectl +kubernetes +kubernetes +ldap +learnings +Leasot +lerna +Lerna +LocalStack +lockdown +lockfile +lunr +Luxon +magiclink +mailto +maintainer's +maintainership +makefile +md +memcache +memoize +memoized +microservice +microservices +microsite +microtasks +middleware +minikube +Minikube +Minio +misconfiguration +misconfigured +mkdocs +Mkdocs +monorepo +Monorepo +monorepos +msgraph +msw +mutex +mutexes +mysql +namespace +namespaced +namespaces +Namespaces +namespacing +neuro +newrelic +nginx +nodegit +nohoist +nonces +noop +npm +nunjucks +nvarchar +nvm +OAuth +octokit +oidc +Okta +Oldsberg +onboarding +Onboarding +OpenShift +orgs +padding +paddings +pagerduty +pageview +parallelization +parseable +Patrik +pattison +Peloton +performant +Performant +periskop +Periskop +permissioned +permissioning +plantuml +Platformize +Podman +postgres +postpack +pre +prebaked +preconfigured +prepack +Preprarer +productional +Protobuf +proxying +Proxying +pseudonymized +pubsub +pygments +pymdownx +rankdir +readme +Readme +readonly +rebase +Recharts +Redash +replicasets +repo +Repo +repos +rerender +rerenders +reusability +Reusability +roadmaps +rollbar +Rollbar +Rollup +routable +Routable +rst +rsync +ruleset +runbook +sam +sanitization +scaffolded +scaffolder +Scaffolder +scrollbar +seb +semlas +semver +serializable +Serverless +shoutout +SIG +SIGs +siloed +Sinon +Snyk +Sonarqube +sourcemaps +sparklines +Splunk +Spotifiers +spotify +Spotify +sqlite +sqs +squidfunk +src +statefulsets +stdout +storable +stringified +stringify +subcomponent +subcomponents +subfolder +subfolders +subheader +subheaders +subkey +subroutes +subtree +superfences +Superfences +superset +supertype +SVGs +talkdesk +Talkdesk +Tanzu +tasklist +techdocs +Telenor +telus +templated +templater +Templater +templaters +Templaters +TFRecord +theia +thumbsup +todo +todos +togglable +tolerations +Tolerations +toolchain +toolsets +tooltip +tooltips +touchpoint +transpilation +transpiled +transpiler +transpilers +truthy +TSDoc +typeahead +ui +unbreak +Unconference +unmanaged +unregister +unregistering +unregistration +untracked +upsert +upvote +URIs +URLs +utils +Valentina +validator +validators +varchar +VMware +VPCs +VSCode +Wayfair +Weaveworks +Webpack +widget's +winston +www +WWW +XCMetrics +XML +xyz +yaml +Zalando +Zhou +zod +Zolotusky +zoomable +zsh +Lainfiesta +allowlisted +Dominik +Henneke +Kuang From e2d61b82fbde63ecfb7c0229c23316d671beaaf1 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 29 Dec 2022 13:11:50 -0500 Subject: [PATCH 6/6] chore: Remove duplicate config flag Signed-off-by: Adam Harvey --- scripts/check-docs-quality.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/check-docs-quality.js b/scripts/check-docs-quality.js index 9c7f444033..10c4b99976 100755 --- a/scripts/check-docs-quality.js +++ b/scripts/check-docs-quality.js @@ -99,7 +99,7 @@ async function main() { if (process.argv.includes('--ci-args')) { process.stdout.write( // Workaround for not being able to pass arguments to the vale action - JSON.stringify(['--config=.github/vale/config.ini', ...files]), + JSON.stringify([...files]), ); return; }