From 0f9cf5585334a735eeeb127e5238381fb0cdd6d0 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Fri, 21 Feb 2025 16:54:07 +0000 Subject: [PATCH 1/3] feat: Add minimal Vale configuration, existing package files This commit adds a new minimal Vale configuration, as well as some package files from a prior iteration of a style guide for NGINX/Vale. There is a lot of nuance to how Vale can be configured: the intent of adding these files is so that we can begin to iterate on what to override, add or disable alongside style guide work. --- .vale.ini | 8 + styles/NGINX/Acronyms.yml | 73 +++ styles/NGINX/Anthropomorphism.yml | 12 + styles/NGINX/Cliches.yml | 725 +++++++++++++++++++++++++++++ styles/NGINX/Foreign.yml | 11 + styles/NGINX/Naming.yml | 26 ++ styles/NGINX/Spelling.yml | 5 + styles/NGINX/WordChoice.yml | 148 ++++++ styles/Vocab/NGINXNouns/accept.txt | 142 ++++++ styles/Vocab/NGINXNouns/reject.txt | 109 +++++ 10 files changed, 1259 insertions(+) create mode 100644 .vale.ini create mode 100644 styles/NGINX/Acronyms.yml create mode 100644 styles/NGINX/Anthropomorphism.yml create mode 100644 styles/NGINX/Cliches.yml create mode 100644 styles/NGINX/Foreign.yml create mode 100644 styles/NGINX/Naming.yml create mode 100644 styles/NGINX/Spelling.yml create mode 100644 styles/NGINX/WordChoice.yml create mode 100644 styles/Vocab/NGINXNouns/accept.txt create mode 100644 styles/Vocab/NGINXNouns/reject.txt diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 000000000..4100d5535 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,8 @@ +StylesPath = styles +MinAlertLevel = suggestion + +Packages = Microsoft, Hugo, NGINX + +[*.{md}] + +BasedOnStyles = Vale, Microsoft, NGINX \ No newline at end of file diff --git a/styles/NGINX/Acronyms.yml b/styles/NGINX/Acronyms.yml new file mode 100644 index 000000000..51f9bc6d9 --- /dev/null +++ b/styles/NGINX/Acronyms.yml @@ -0,0 +1,73 @@ +extends: conditional +message: "'%s' has no definition." +level: suggestion +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b([A-Z]{3,5})\b' +second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' +# ... with the exception of these: +exceptions: + - API + - ASP + - CLI + - CPU + - CSS + - CSV + - DEBUG + - DELETE + - DOM + - DPI + - F5 + - FAQ + - GCC + - GDB + - GET + - GPU + - GTK + - GUI + - HTML + - HTTP + - HTTPS + - IDE + - IETF + - JAR + - JSON + - JSX + - LESS + - LLDB + - NET + - NOTE + - NVDA + - NGINX + - OSS + - PATH + - PATCH + - PDF + - PHP + - POST + - PUT + - RAM + - REPL + - REST + - RSA + - SCM + - SCSS + - SDK + - SQL + - SSH + - SSL + - SVG + - TBD + - TCP + - TODO + - TMOS + - URI + - URL + - USB + - UTF + - VLAN + - VPN + - XML + - XSS + - YAML + - ZIP \ No newline at end of file diff --git a/styles/NGINX/Anthropomorphism.yml b/styles/NGINX/Anthropomorphism.yml new file mode 100644 index 000000000..43e6df773 --- /dev/null +++ b/styles/NGINX/Anthropomorphism.yml @@ -0,0 +1,12 @@ +extends: existence +message: "The word %s' is anthropomorphic. If possible, use a different word if you're referring to a product." +ignorecase: true +#code: false +level: error +tokens: + - decides + - knows + - listens + - hears + - sees + - walks diff --git a/styles/NGINX/Cliches.yml b/styles/NGINX/Cliches.yml new file mode 100644 index 000000000..f5b208cc8 --- /dev/null +++ b/styles/NGINX/Cliches.yml @@ -0,0 +1,725 @@ +extends: existence +message: "'%s' is a cliché" +ignorecase: true +level: suggestion +tokens: + - a chip off the old block + - a clean slate + - a dark and stormy night + - a far cry + - a fine kettle of fish + - a loose cannon + - a penny saved is a penny earned + - a tough row to hoe + - a word to the wise + - ace in the hole + - acid test + - add insult to injury + - against all odds + - air your dirty laundry + - all fun and games + - all hands on deck + - all in a day's work + - all talk, no action + - all thumbs + - all your eggs in one basket + - all's fair in love and war + - all's well that ends well + - almighty dollar + - American as apple pie + - an axe to grind + - another day, another dollar + - apples to apples + - armed to the teeth + - as luck would have it + - as old as time + - as the crow flies + - at loose ends + - at my wits end + - at the end of the day + - avoid like the plague + - babe in the woods + - back against the wall + - back in the saddle + - back to square one + - back to the drawing board + - bad to the bone + - badge of honor + - bald faced liar + - ballpark figure + - bang for your buck + - banging your head against a brick wall + - baptism by fire + - barking up the wrong tree + - bat out of hell + - be all and end all + - beat a dead horse + - beat around the bush + - been there, done that + - beggars can't be choosers + - behind the eight ball + - bend over backwards + - benefit of the doubt + - bent out of shape + - best thing since sliced bread + - bet your bottom dollar + - better half + - better late than never + - better mousetrap + - better safe than sorry + - between a rock and a hard place + - beyond the pale + - bide your time + - big as life + - big cheese + - big fish in a small pond + - big man on campus + - bigger they are the harder they fall + - bird in the hand + - bird's eye view + - birds and the bees + - birds of a feather flock together + - bit the hand that feeds you + - bite the bullet + - bite the dust + - bitten off more than he can chew + - black as coal + - black as pitch + - black as the ace of spades + - blast from the past + - bleeding heart + - blessing in disguise + - blind ambition + - blind as a bat + - blind leading the blind + - blood is thicker than water + - blood sweat and tears + - blow off steam + - blow your own horn + - blushing bride + - boils down to + - bolt from the blue + - bone to pick + - bored stiff + - bored to tears + - bottomless pit + - boys will be boys + - bright and early + - brings home the bacon + - broad across the beam + - broken record + - brought back to reality + - bull by the horns + - bull in a china shop + - burn the midnight oil + - burning question + - burning the candle at both ends + - burst your bubble + - bury the hatchet + - busy as a bee + - by hook or by crook + - call a spade a spade + - called onto the carpet + - calm before the storm + - can of worms + - can't cut the mustard + - can't hold a candle to + - case of mistaken identity + - cat got your tongue + - cat's meow + - caught in the crossfire + - caught red-handed + - checkered past + - chomping at the bit + - circle back around + - cleanliness is next to godliness + - clear as a bell + - clear as mud + - close to the vest + - cock and bull story + - cold shoulder + - come hell or high water + - cool as a cucumber + - cool, calm, and collected + - cost a king's ransom + - count your blessings + - crack of dawn + - crash course + - creature comforts + - cross that bridge when you come to it + - crushing blow + - cry like a baby + - cry me a river + - cry over spilt milk + - crystal clear + - curiosity killed the cat + - cut and dried + - cut through the red tape + - cut to the chase + - cute as a bugs ear + - cute as a button + - cute as a puppy + - cuts to the quick + - dark before the dawn + - day in, day out + - dead as a doornail + - devil is in the details + - dime a dozen + - divide and conquer + - dog and pony show + - dog days + - dog eat dog + - dog tired + - don't burn your bridges + - don't count your chickens + - don't look a gift horse in the mouth + - don't rock the boat + - don't step on anyone's toes + - don't take any wooden nickels + - down and out + - down at the heels + - down in the dumps + - down the hatch + - down to earth + - draw the line + - dressed to kill + - dressed to the nines + - drill-down + - drives me up the wall + - dull as dishwater + - dyed in the wool + - eagle eye + - ear to the ground + - early bird catches the worm + - easier said than done + - easy as pie + - eat your heart out + - eat your words + - elephant in the room + - eleventh hour + - even the playing field + - every dog has its day + - every fiber of my being + - everything but the kitchen sink + - eye for an eye + - face the music + - facts of life + - fair weather friend + - fall by the wayside + - fan the flames + - feast or famine + - feather your nest + - feathered friends + - few and far between + - fifteen minutes of fame + - filthy vermin + - fine kettle of fish + - fish out of water + - fishing for a compliment + - fit as a fiddle + - fit the bill + - fit to be tied + - flash in the pan + - flat as a pancake + - flip your lid + - flog a dead horse + - fly by night + - fly the coop + - follow your heart + - for all intents and purposes + - for the birds + - for what it's worth + - force of nature + - force to be reckoned with + - forgive and forget + - fox in the henhouse + - free and easy + - free as a bird + - fresh as a daisy + - full steam ahead + - fun in the sun + - garbage in, garbage out + - gentle as a lamb + - get a kick out of + - get a leg up + - get down and dirty + - get my manager's blessing + - get the ball rolling + - get the lead out + - get to the bottom of + - get your feet wet + - gets my goat + - gilding the lily + - give and take + - go against the grain + - go at it tooth and nail + - go for broke + - go him one better + - go the extra mile + - go with the flow + - goes without saying + - good as gold + - good deed for the day + - good things come to those who wait + - good time was had by all + - good times were had by all + - greased lightning + - greek to me + - green thumb + - green-eyed monster + - grist for the mill + - growing like a weed + - hair of the dog + - hand to mouth + - happy as a clam + - happy as a lark + - hasn't a clue + - have a nice day + - have high hopes + - have the last laugh + - haven't got a row to hoe + - head honcho + - head over heels + - hear a pin drop + - heard it through the grapevine + - heart's content + - heavy as lead + - hem and haw + - high and dry + - high and mighty + - high as a kite + - hit paydirt + - hit the ground running + - hold your head up high + - hold your horses + - hold your own + - hold your tongue + - honest as the day is long + - horns of a dilemma + - horse of a different color + - hot under the collar + - hour of need + - I beg to differ + - i don't have the bandwidth + - icing on the cake + - if the shoe fits + - if the shoe were on the other foot + - in a jam + - in a jiffy + - in a nutshell + - in a pig's eye + - in a pinch + - in a word + - in hot water + - in the gutter + - in the nick of time + - in the thick of it + - in your dreams + - it ain't over till the fat lady sings + - it goes without saying + - it takes all kinds + - it takes one to know one + - it's a small world + - it's on my radar + - it's only a matter of time + - ivory tower + - Jack of all trades + - jockey for position + - jog your memory + - joined at the hip + - judge a book by its cover + - jump down your throat + - jump in with both feet + - jump on the bandwagon + - jump the gun + - jump to conclusions + - just a hop, skip, and a jump + - just the ticket + - justice is blind + - keep a stiff upper lip + - keep an eye on + - keep it simple, stupid + - keep the home fires burning + - keep up with the Joneses + - keep your chin up + - keep your fingers crossed + - kick the bucket + - kick up your heels + - kick your feet up + - kid in a candy store + - kill two birds with one stone + - kiss of death + - knock it out of the park + - knock on wood + - knock your socks off + - know him from Adam + - know the ropes + - know the score + - knuckle down + - knuckle sandwich + - knuckle under + - labor of love + - ladder of success + - land on your feet + - lap of luxury + - last but not least + - last hurrah + - last-ditch effort + - law of the jungle + - law of the land + - lay down the law + - leaps and bounds + - let sleeping dogs lie + - let the cat out of the bag + - let the good times roll + - let your hair down + - let's talk turkey + - let's touch base + - letter perfect + - lick your wounds + - lies like a rug + - life's a bitch + - life's a grind + - light at the end of the tunnel + - lighter than a feather + - lighter than air + - like clockwork + - like father like son + - like taking candy from a baby + - like there's no tomorrow + - lion's share + - live and learn + - live and let live + - long and short of it + - long lost love + - look before you leap + - look down your nose + - look what the cat dragged in + - looking a gift horse in the mouth + - looks like death warmed over + - loose cannon + - lose your head + - lose your temper + - loud as a horn + - lounge lizard + - loved and lost + - low man on the totem pole + - low-hanging fruit + - luck of the draw + - luck of the Irish + - make hay while the sun shines + - make money hand over fist + - make my day + - make the best of a bad situation + - make the best of it + - make your blood boil + - man of few words + - man's best friend + - mark my words + - meaningful dialogue + - missed the boat on that one + - moment in the sun + - moment of glory + - moment of truth + - money to burn + - more power to you + - more than one way to skin a cat + - move the goal post + - movers and shakers + - moving experience + - naked as a jaybird + - naked truth + - neat as a pin + - needle in a haystack + - needless to say + - neither here nor there + - never look back + - never say never + - nip and tuck + - nip it in the bud + - no brainer + - no guts, no glory + - no love lost + - no pain, no gain + - no skin off my back + - no stone unturned + - no time like the present + - no use crying over spilled milk + - nose to the grindstone + - not a hope in hell + - not a minute's peace + - not in my backyard + - not playing with a full deck + - not the end of the world + - not written in stone + - nothing to sneeze at + - nothing ventured nothing gained + - now we're cooking + - off the top of my head + - off the wagon + - off the wall + - old hat + - older and wiser + - older than dirt + - older than Methuselah + - on a roll + - on cloud nine + - on my plate + - on pins and needles + - on the bandwagon + - on the money + - on the nose + - on the rocks + - on the spot + - on the tip of my tongue + - on the wagon + - on thin ice + - once bitten, twice shy + - one bad apple doesn't spoil the bushel + - one born every minute + - one brick short + - one foot in the grave + - one in a million + - one red cent + - only game in town + - open a can of worms + - open and shut case + - open the flood gates + - opportunity doesn't knock twice + - out of pocket + - out of sight, out of mind + - out of the frying pan into the fire + - out of the woods + - out on a limb + - over a barrel + - over the hump + - pain and suffering + - pain in the + - panic button + - par for the course + - part and parcel + - party pooper + - pass the buck + - patience is a virtue + - pay through the nose + - penny pincher + - perfect storm + - pig in a poke + - pile it on + - pillar of the community + - pin your hopes on + - ping me + - pitter patter of little feet + - plain as day + - plain as the nose on your face + - play by the rules + - play your cards right + - playing the field + - playing with fire + - pleased as punch + - plenty of fish in the sea + - point with pride + - poor as a church mouse + - pot calling the kettle black + - pretty as a picture + - pull a fast one + - pull your punches + - pulling your leg + - pure as the driven snow + - put it in a nutshell + - put one over on you + - put the cart before the horse + - put the pedal to the metal + - put your best foot forward + - put your foot down + - quick as a bunny + - quick as a lick + - quick as a wink + - quick as lightning + - quiet as a dormouse + - rags to riches + - raining buckets + - raining cats and dogs + - rank and file + - rat race + - reap what you sow + - red as a beet + - red herring + - reinvent the wheel + - rich and famous + - rings a bell + - ripe old age + - ripped me off + - rise and shine + - road to hell is paved with good intentions + - rob Peter to pay Paul + - roll over in the grave + - rub the wrong way + - ruled the roost + - running in circles + - sad but true + - sadder but wiser + - salt of the earth + - scared stiff + - scared to death + - sealed with a kiss + - second to none + - see eye to eye + - seen the light + - seize the day + - set the record straight + - set the world on fire + - set your teeth on edge + - sharp as a tack + - shoot for the moon + - shoot the breeze + - shot in the dark + - shoulder to the wheel + - sick as a dog + - sigh of relief + - signed, sealed, and delivered + - sink or swim + - six of one, half a dozen of another + - skating on thin ice + - slept like a log + - slinging mud + - slippery as an eel + - slow as molasses + - smart as a whip + - smooth as a baby's bottom + - sneaking suspicion + - snug as a bug in a rug + - sow wild oats + - spare the rod, spoil the child + - speak of the devil + - spilled the beans + - spinning your wheels + - spitting image of + - spoke with relish + - spread like wildfire + - spring to life + - squeaky wheel gets the grease + - stands out like a sore thumb + - start from scratch + - stick in the mud + - still waters run deep + - stitch in time + - stop and smell the roses + - straight as an arrow + - straw that broke the camel's back + - strong as an ox + - stubborn as a mule + - stuff that dreams are made of + - stuffed shirt + - sweating blood + - sweating bullets + - synergy + - take a load off + - take one for the team + - take the bait + - take the bull by the horns + - take the plunge + - take this offline + - takes one to know one + - takes two to tango + - the more the merrier + - the real deal + - the real McCoy + - the red carpet treatment + - the same old story + - there is no accounting for taste + - thick as a brick + - thick as thieves + - thin as a rail + - think outside of the box + - think outside the box + - third time's the charm + - this day and age + - this hurts me worse than it hurts you + - this point in time + - three sheets to the wind + - through thick and thin + - throw in the towel + - thrown under the bus + - tie one on + - tighter than a drum + - time and time again + - time is of the essence + - tip of the iceberg + - tired but happy + - to coin a phrase + - to each his own + - to make a long story short + - to the best of my knowledge + - toe the line + - tongue in cheek + - too good to be true + - too hot to handle + - too numerous to mention + - touch with a ten foot pole + - tough as nails + - trial and error + - trials and tribulations + - tried and true + - trip down memory lane + - twist of fate + - two cents worth + - two peas in a pod + - ugly as sin + - under the counter + - under the gun + - under the same roof + - under the weather + - until the cows come home + - unvarnished truth + - up the creek + - uphill battle + - upper crust + - upset the applecart + - vain attempt + - vain effort + - vanquish the enemy + - vested interest + - waiting for the other shoe to drop + - wakeup call + - warm welcome + - watch your p's and q's + - watch your tongue + - watching the clock + - water under the bridge + - weather the storm + - weed them out + - week of Sundays + - went belly up + - wet behind the ears + - what goes around comes around + - what you see is what you get + - when it rains, it pours + - when push comes to shove + - when the cat's away + - when the going gets tough, the tough get going + - white as a sheet + - whole ball of wax + - whole hog + - whole nine yards + - wild goose chase + - will wonders never cease? + - win-win + - wisdom of the ages + - wise as an owl + - wolf at the door + - words fail me + - work like a dog + - world weary + - worst nightmare + - worth its weight in gold + - wrong side of the bed + - yanking your chain + - yappy as a dog + - years young + - you are what you eat + - you can run but you can't hide + - you only live once + - you're the boss + - young and foolish + - young and vibrant \ No newline at end of file diff --git a/styles/NGINX/Foreign.yml b/styles/NGINX/Foreign.yml new file mode 100644 index 000000000..ad8f375b2 --- /dev/null +++ b/styles/NGINX/Foreign.yml @@ -0,0 +1,11 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +ignorecase: true +level: error +nonword: true +action: + name: replace +swap: + '\b(?:eg|e\.g\.)[\s,]': for example + '\b(?:ie|i\.e\.)[\s,]': that is + '\b(?:etc|etc\.)[\s,]': and so on \ No newline at end of file diff --git a/styles/NGINX/Naming.yml b/styles/NGINX/Naming.yml new file mode 100644 index 000000000..27f4f8bab --- /dev/null +++ b/styles/NGINX/Naming.yml @@ -0,0 +1,26 @@ +extends: substitution +message: Make sure to use the full name '%s' instead of the short name '%s'. +action: + name: replace +level: error +#code: false +ignorecase: false +swap: + ACM: NGINX API Connectivity Manager + ADM: NGINX App Delivery Manager + Amplify: NGINX Amplify + App Protect: NGINX App Protect + '(?:Dev Central|DC|dc|dev central|devCentral)': DevCentral + '(?:big-ip|BigIp|Big-IP|Big IP|Big Ip|BIGIp)': BIG-IP + '(?:big-iq|BigIq|Big-IQ|Big IQ|Big Iq|BIGIq)': BIG-IQ + F5 Networks: F5, Inc. + Controller: NGINX Controller + '(?:NIC|Ingress Controller)': NGINX Ingress Controller + nginx: NGINX + '(?:nginx\+|NGINX\+|N\+)': NGINX Plus + '(?:oss|OSS)': NGINX OSS + NIM: NGINX Instance Manager + NSM: NGINX Service Mesh + NMS: NGINX Management Suite + Unit: NGINX Unit + diff --git a/styles/NGINX/Spelling.yml b/styles/NGINX/Spelling.yml new file mode 100644 index 000000000..c8baf4bef --- /dev/null +++ b/styles/NGINX/Spelling.yml @@ -0,0 +1,5 @@ +extends: spelling +message: "Spelling error: '%s'." +level: error +code: false +ignorecase: true \ No newline at end of file diff --git a/styles/NGINX/WordChoice.yml b/styles/NGINX/WordChoice.yml new file mode 100644 index 000000000..28e770c80 --- /dev/null +++ b/styles/NGINX/WordChoice.yml @@ -0,0 +1,148 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +ignorecase: false +#code: false +level: suggestion +action: + name: replace +swap: + above: preceding|previous + '(?:anti-virus|anti virus)': antivirus + api: API + '(?:AskF5 Knowledgebase|AskF5 portal)': AskF5 + authorisation: authorization + '(?:black list|blacklist|blacklisted)': blocklist|block list|deny list|denylisted + backwards: backward + '(?:bare metal|on-prem)': private cloud + baz: a real-world example + below: following + blade: panel + '(?:boot|boot up|reboot)': start|restart + BIG-IPs: BIG-IP systems + cachable: cacheable + cacheing: caching + card holder: cardholder + case-insensitive: not case-sensitive + check: verify|confirm|test|ensure + checkbox: check box + cli: CLI + click: select + client side: hyphenate as client-side when used as adjective + cloud native: cloud-native + cloud ready: cloud-ready + colour: color + configure: set + core: don't use as a verb + core dump: core file + coreos: CoreOS + controlplane: control plane + '(?:cyber-attack|cyberattack)': cyber attack + '(?:crash|crashes|crashed)': stops responding|shuts down|system restarts + data are: data is + datacenter: data center + dataplane: data plane + datastore: datastor + de-duplicate: deduplicate + de-duplication: deduplication + '(?:demilitarized zone|DMZ)': perimeter network + dev: developer|development + dialog box: pop-up window|pop-up screen + '(?:drop-down|dropdown|drop-down box)': list + e-mail: email + enable: use a stronger verb if possible + '(?:end point|end-point)': endpoint + end-user: user + '(?:hand held|hand-held)': handheld + '(?:hair pinning|hair-pinning)': hairpinning + env: environment + etcetera: and so on + executables: system files + execute: use|enter|start|run + extraneous: extra|unneeded + Extranet: extranet + F5 Technical Support: F5 Support + filename: file name + forward slash: slash + forwards: forward + grayed out: unavailable + grpc: GRPC + '(?:GUI|WebGUI|WebUI|UI)': user interface|browser interface + hacker: malicious user + hang: fail to respond|become unavailable + homepage: home page + hostname: host name + hot fix: hotfix + '(?:hover on|hover in)': hover over + impact: affect + input: don't use as a verb; use type instead + Internet: internet + Intranet: intranet + jaeger: Jaeger + jwt: JWT + '(?:K8s|k8s|kubernetes)': Kubernetes + leverage: use + list box: box + load-balance: load balance + load-balancer: load balancer + load-balancing: load balancing + lower case: lowercase + master: primary|principal|control|main + mouse: cursor + mouse over: hover over + multi layer: multi-layer + '(?:micro-service|micro service)': microservice + '(?:multicloud|multi cloud)': multi-cloud + '(?:multilayer|multi layer)': multi-layer + '(?:multitenancy|multi tenancy)': multi-tenancy + '(?:nameserver|name-server)': name server + name space: namespace + net: network + netmask: network mask + NGINX Technical Support: NGINX Support + '(?:off-load|off load)': offload + '(?:plugin|plug in)': plug-in + '(?:readonly|read only)': read-only + openapi: OpenAPI + path name: path|file name + pem: PEM + pfx: PFX + pkcs: PKCS + pointer: cursor + power off: shut down + prometheus: Prometheus + query: get|list + radio button: refer to the item by its label + rbac: RBAC + repo: repository + reprovision: re-provision + roadmap: road map + rpc: RPC + shortcut menu: menu + slave: secondary|replica|agent|worker + smart phone: smartphone + smartcard: smart card + spin down: remove + spin up: create + subdir: subdirectory + '(?:thruput|through put)': throughput + text box: box + timeframe: time frame + tool set: toolset + touch screen: touchscreen + uncheck: deselect + url: URL + user name: username + userID: user ID + utilize: use + via: by means of|through + vice versa: conversely + '(?:virtual IP|VIP)': virtual address + web site: website + webpage: web page + webserver: web server + '(?:white list|whitelist|whitelisted)': allowlist|allow list|allowlisted + '(?:wifi|WiFi)': Wi-Fi + '(?:window|screen)': page + '(?:wish|desire)': want|need|require|prefer + yaml: YAML + zipkin: Zipkin diff --git a/styles/Vocab/NGINXNouns/accept.txt b/styles/Vocab/NGINXNouns/accept.txt new file mode 100644 index 000000000..5beff3a59 --- /dev/null +++ b/styles/Vocab/NGINXNouns/accept.txt @@ -0,0 +1,142 @@ +api +API +apigw +APIs +apis +autoscale +bck +cacert +cfg +cgroup +Cgroup +CLI +cmd +coredns +coreos +config +configs +CSR +csharp +datastore +datastor +denylist +denylisting +Denylist +Denylisting +dev +Dev +devportal +dev-portal +dll +Docker +Dockerfile +downsampled +downsample +eml +enum +etcd +exe +f5net +GRPC +GitHub +GitLab +GitSwarm +gitlab +gitswarm +Grafana +grpc +gzip +healthz +host +hostname +hta +htr +htw +http +https +HTTP +HTTPS +ida +idc +idq +img +ini +injectable +io +Jenkinsfile +jpg +jpeg +Joomla +joomla +json +jwt +keepalive +kubeadm +kubeconfig +kubectl +Kubelet +kubelet +kubernetes +md +meshctl +namespace +namespaces +nginx +nginx-meshctl +ngx +objc +openapi +opentracing +pem +pfx +pkcs +PKCS +png +PNG +productpage +prometheus +proto +protoc +protobuf +psql +psutil +repo +revalidate +revalidated +rcvd +ref +relref +rpc +RPC +runtime +runtimes +semver +servlets +Servlets +smi +src +ssl +stdin +stdout +subdir +subnet +svc +syslog +timeframe +Timeframe +ttfb +unavail +unencrypted +unmute +Unmute +unparsable +URIs +URI +waf +WAF +walkthrough +webserver +yaml +YAML +Zipkin +zipkin \ No newline at end of file diff --git a/styles/Vocab/NGINXNouns/reject.txt b/styles/Vocab/NGINXNouns/reject.txt new file mode 100644 index 000000000..93fea7a4c --- /dev/null +++ b/styles/Vocab/NGINXNouns/reject.txt @@ -0,0 +1,109 @@ +abort +abortion +alameda +aluminum +apollo +argon +armstrong +asshole +at&t +atlantis +attacker +badger +barkan +beryllium +bitch +blacklist +bourne +calcite +carbon +cascade +centaur +cerberus +cesium +cheetah +chougar +chromium +columbia +corona +costco +cougar +d-alcite +dammit +damn +danburite +daytona +deschutes +diamond +disan +discoveryplatform +dolomite +douche +draco +drycreek +dvora +endeavour +equinox +evergreen +exploit +fidelity +firebolt +firestone +flyout +foo +foobar +foobar +fu +fubar +fubar +fuck +gemini +greenflash +greenflash +hacker +hsibj +ironside +joffre +jpmc +kill +linecard +master +mercury +moonshot +octeon +olivia +parkcity +pathological +please +predator +puma +quasar +redmountain +scorpion +shit +shuttle +slave +solar +solstice +somevar +sonoma +stagsleap +stirling +stratos +techmatrix +terminate +thankyou +threat +tokyo +treadstone +trident +vancouver +verizon +vic1 +vic2 +vicii +victoria +vzw +whitelist +whitethorne +zenith \ No newline at end of file From 3a27ece1cec3d3221577002e924b28c119ba235c Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Fri, 21 Feb 2025 17:02:26 +0000 Subject: [PATCH 2/3] feat: Fix .vale.ini error, update .gitignore file --- .gitignore | 8 ++++---- .vale.ini | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index e0070f1b2..4ee3ece68 100644 --- a/.gitignore +++ b/.gitignore @@ -30,10 +30,10 @@ resources/ .markdownlint.json **/.vscode/ **/.idea/ - -# Local Netlify artifacts -.netlify/plugins/* -.netlify/ + +# Vale files +/styles/Microsoft +/styles/.vale-config/1-Hugo.ini # Local Lighthouse artifacts lighthouse-reports diff --git a/.vale.ini b/.vale.ini index 4100d5535..841d1d9d1 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,7 +1,7 @@ StylesPath = styles MinAlertLevel = suggestion -Packages = Microsoft, Hugo, NGINX +Packages = Microsoft, Hugo [*.{md}] From 66d2885ed3c1d96e7514ccc0f6be10f3f495fa15 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 12 Mar 2025 13:11:35 +0000 Subject: [PATCH 3/3] feat: Additional testing work --- .vale.ini | 4 +- documentation/README.md | 13 + documentation/vale.md | 1 + styles/NGINX/Acronyms.yml | 73 -- styles/NGINX/Anthropomorphism.yml | 12 - styles/NGINX/Cliches.yml | 725 ------------------ styles/NGINX/Foreign.yml | 11 - styles/NGINX/Naming.yml | 26 - styles/NGINX/Spelling.yml | 5 - styles/NGINX/Terms.yaml | 6 + styles/NGINX/WordChoice.yml | 148 ---- styles/Vocab/NGINXNouns/accept.txt | 142 ---- styles/Vocab/NGINXNouns/reject.txt | 109 --- .../config/vocabularies/Kubernetes/accept.txt | 7 + styles/config/vocabularies/NGINX/accept.txt | 3 + 15 files changed, 33 insertions(+), 1252 deletions(-) create mode 100644 documentation/README.md create mode 100644 documentation/vale.md delete mode 100644 styles/NGINX/Acronyms.yml delete mode 100644 styles/NGINX/Anthropomorphism.yml delete mode 100644 styles/NGINX/Cliches.yml delete mode 100644 styles/NGINX/Foreign.yml delete mode 100644 styles/NGINX/Naming.yml delete mode 100644 styles/NGINX/Spelling.yml create mode 100644 styles/NGINX/Terms.yaml delete mode 100644 styles/NGINX/WordChoice.yml delete mode 100644 styles/Vocab/NGINXNouns/accept.txt delete mode 100644 styles/Vocab/NGINXNouns/reject.txt create mode 100644 styles/config/vocabularies/Kubernetes/accept.txt create mode 100644 styles/config/vocabularies/NGINX/accept.txt diff --git a/.vale.ini b/.vale.ini index 841d1d9d1..786c931c1 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,8 +1,10 @@ StylesPath = styles MinAlertLevel = suggestion +Vocab = NGINX, Kubernetes + Packages = Microsoft, Hugo [*.{md}] -BasedOnStyles = Vale, Microsoft, NGINX \ No newline at end of file +BasedOnStyles = NGINX, Microsoft \ No newline at end of file diff --git a/documentation/README.md b/documentation/README.md new file mode 100644 index 000000000..b329c627e --- /dev/null +++ b/documentation/README.md @@ -0,0 +1,13 @@ +# NGINX Documentation repository + +This directory contains the maintenance documentation for the NGINX Documentation repository. + +It explains how to configure tooling for the repository, and instructions for some precise tasks. + +If you're interested in contributing to the [NGINX documentation website](https://docs.nginx.com/), check out [CONTRIBUTING.md](https://github.com/nginx/documentation/blob/main/CONTRIBUTING.md). + +Most of the documentation you'll see here is for the DocOps team, maintained publicly as part of NGINX's commitment to transparency and open source. + +## Topics + +- [Updating Vale rules](vale.md) \ No newline at end of file diff --git a/documentation/vale.md b/documentation/vale.md new file mode 100644 index 000000000..f98fffbb0 --- /dev/null +++ b/documentation/vale.md @@ -0,0 +1 @@ +# Updating Vale rules diff --git a/styles/NGINX/Acronyms.yml b/styles/NGINX/Acronyms.yml deleted file mode 100644 index 51f9bc6d9..000000000 --- a/styles/NGINX/Acronyms.yml +++ /dev/null @@ -1,73 +0,0 @@ -extends: conditional -message: "'%s' has no definition." -level: suggestion -ignorecase: false -# Ensures that the existence of 'first' implies the existence of 'second'. -first: '\b([A-Z]{3,5})\b' -second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' -# ... with the exception of these: -exceptions: - - API - - ASP - - CLI - - CPU - - CSS - - CSV - - DEBUG - - DELETE - - DOM - - DPI - - F5 - - FAQ - - GCC - - GDB - - GET - - GPU - - GTK - - GUI - - HTML - - HTTP - - HTTPS - - IDE - - IETF - - JAR - - JSON - - JSX - - LESS - - LLDB - - NET - - NOTE - - NVDA - - NGINX - - OSS - - PATH - - PATCH - - PDF - - PHP - - POST - - PUT - - RAM - - REPL - - REST - - RSA - - SCM - - SCSS - - SDK - - SQL - - SSH - - SSL - - SVG - - TBD - - TCP - - TODO - - TMOS - - URI - - URL - - USB - - UTF - - VLAN - - VPN - - XML - - XSS - - YAML - - ZIP \ No newline at end of file diff --git a/styles/NGINX/Anthropomorphism.yml b/styles/NGINX/Anthropomorphism.yml deleted file mode 100644 index 43e6df773..000000000 --- a/styles/NGINX/Anthropomorphism.yml +++ /dev/null @@ -1,12 +0,0 @@ -extends: existence -message: "The word %s' is anthropomorphic. If possible, use a different word if you're referring to a product." -ignorecase: true -#code: false -level: error -tokens: - - decides - - knows - - listens - - hears - - sees - - walks diff --git a/styles/NGINX/Cliches.yml b/styles/NGINX/Cliches.yml deleted file mode 100644 index f5b208cc8..000000000 --- a/styles/NGINX/Cliches.yml +++ /dev/null @@ -1,725 +0,0 @@ -extends: existence -message: "'%s' is a cliché" -ignorecase: true -level: suggestion -tokens: - - a chip off the old block - - a clean slate - - a dark and stormy night - - a far cry - - a fine kettle of fish - - a loose cannon - - a penny saved is a penny earned - - a tough row to hoe - - a word to the wise - - ace in the hole - - acid test - - add insult to injury - - against all odds - - air your dirty laundry - - all fun and games - - all hands on deck - - all in a day's work - - all talk, no action - - all thumbs - - all your eggs in one basket - - all's fair in love and war - - all's well that ends well - - almighty dollar - - American as apple pie - - an axe to grind - - another day, another dollar - - apples to apples - - armed to the teeth - - as luck would have it - - as old as time - - as the crow flies - - at loose ends - - at my wits end - - at the end of the day - - avoid like the plague - - babe in the woods - - back against the wall - - back in the saddle - - back to square one - - back to the drawing board - - bad to the bone - - badge of honor - - bald faced liar - - ballpark figure - - bang for your buck - - banging your head against a brick wall - - baptism by fire - - barking up the wrong tree - - bat out of hell - - be all and end all - - beat a dead horse - - beat around the bush - - been there, done that - - beggars can't be choosers - - behind the eight ball - - bend over backwards - - benefit of the doubt - - bent out of shape - - best thing since sliced bread - - bet your bottom dollar - - better half - - better late than never - - better mousetrap - - better safe than sorry - - between a rock and a hard place - - beyond the pale - - bide your time - - big as life - - big cheese - - big fish in a small pond - - big man on campus - - bigger they are the harder they fall - - bird in the hand - - bird's eye view - - birds and the bees - - birds of a feather flock together - - bit the hand that feeds you - - bite the bullet - - bite the dust - - bitten off more than he can chew - - black as coal - - black as pitch - - black as the ace of spades - - blast from the past - - bleeding heart - - blessing in disguise - - blind ambition - - blind as a bat - - blind leading the blind - - blood is thicker than water - - blood sweat and tears - - blow off steam - - blow your own horn - - blushing bride - - boils down to - - bolt from the blue - - bone to pick - - bored stiff - - bored to tears - - bottomless pit - - boys will be boys - - bright and early - - brings home the bacon - - broad across the beam - - broken record - - brought back to reality - - bull by the horns - - bull in a china shop - - burn the midnight oil - - burning question - - burning the candle at both ends - - burst your bubble - - bury the hatchet - - busy as a bee - - by hook or by crook - - call a spade a spade - - called onto the carpet - - calm before the storm - - can of worms - - can't cut the mustard - - can't hold a candle to - - case of mistaken identity - - cat got your tongue - - cat's meow - - caught in the crossfire - - caught red-handed - - checkered past - - chomping at the bit - - circle back around - - cleanliness is next to godliness - - clear as a bell - - clear as mud - - close to the vest - - cock and bull story - - cold shoulder - - come hell or high water - - cool as a cucumber - - cool, calm, and collected - - cost a king's ransom - - count your blessings - - crack of dawn - - crash course - - creature comforts - - cross that bridge when you come to it - - crushing blow - - cry like a baby - - cry me a river - - cry over spilt milk - - crystal clear - - curiosity killed the cat - - cut and dried - - cut through the red tape - - cut to the chase - - cute as a bugs ear - - cute as a button - - cute as a puppy - - cuts to the quick - - dark before the dawn - - day in, day out - - dead as a doornail - - devil is in the details - - dime a dozen - - divide and conquer - - dog and pony show - - dog days - - dog eat dog - - dog tired - - don't burn your bridges - - don't count your chickens - - don't look a gift horse in the mouth - - don't rock the boat - - don't step on anyone's toes - - don't take any wooden nickels - - down and out - - down at the heels - - down in the dumps - - down the hatch - - down to earth - - draw the line - - dressed to kill - - dressed to the nines - - drill-down - - drives me up the wall - - dull as dishwater - - dyed in the wool - - eagle eye - - ear to the ground - - early bird catches the worm - - easier said than done - - easy as pie - - eat your heart out - - eat your words - - elephant in the room - - eleventh hour - - even the playing field - - every dog has its day - - every fiber of my being - - everything but the kitchen sink - - eye for an eye - - face the music - - facts of life - - fair weather friend - - fall by the wayside - - fan the flames - - feast or famine - - feather your nest - - feathered friends - - few and far between - - fifteen minutes of fame - - filthy vermin - - fine kettle of fish - - fish out of water - - fishing for a compliment - - fit as a fiddle - - fit the bill - - fit to be tied - - flash in the pan - - flat as a pancake - - flip your lid - - flog a dead horse - - fly by night - - fly the coop - - follow your heart - - for all intents and purposes - - for the birds - - for what it's worth - - force of nature - - force to be reckoned with - - forgive and forget - - fox in the henhouse - - free and easy - - free as a bird - - fresh as a daisy - - full steam ahead - - fun in the sun - - garbage in, garbage out - - gentle as a lamb - - get a kick out of - - get a leg up - - get down and dirty - - get my manager's blessing - - get the ball rolling - - get the lead out - - get to the bottom of - - get your feet wet - - gets my goat - - gilding the lily - - give and take - - go against the grain - - go at it tooth and nail - - go for broke - - go him one better - - go the extra mile - - go with the flow - - goes without saying - - good as gold - - good deed for the day - - good things come to those who wait - - good time was had by all - - good times were had by all - - greased lightning - - greek to me - - green thumb - - green-eyed monster - - grist for the mill - - growing like a weed - - hair of the dog - - hand to mouth - - happy as a clam - - happy as a lark - - hasn't a clue - - have a nice day - - have high hopes - - have the last laugh - - haven't got a row to hoe - - head honcho - - head over heels - - hear a pin drop - - heard it through the grapevine - - heart's content - - heavy as lead - - hem and haw - - high and dry - - high and mighty - - high as a kite - - hit paydirt - - hit the ground running - - hold your head up high - - hold your horses - - hold your own - - hold your tongue - - honest as the day is long - - horns of a dilemma - - horse of a different color - - hot under the collar - - hour of need - - I beg to differ - - i don't have the bandwidth - - icing on the cake - - if the shoe fits - - if the shoe were on the other foot - - in a jam - - in a jiffy - - in a nutshell - - in a pig's eye - - in a pinch - - in a word - - in hot water - - in the gutter - - in the nick of time - - in the thick of it - - in your dreams - - it ain't over till the fat lady sings - - it goes without saying - - it takes all kinds - - it takes one to know one - - it's a small world - - it's on my radar - - it's only a matter of time - - ivory tower - - Jack of all trades - - jockey for position - - jog your memory - - joined at the hip - - judge a book by its cover - - jump down your throat - - jump in with both feet - - jump on the bandwagon - - jump the gun - - jump to conclusions - - just a hop, skip, and a jump - - just the ticket - - justice is blind - - keep a stiff upper lip - - keep an eye on - - keep it simple, stupid - - keep the home fires burning - - keep up with the Joneses - - keep your chin up - - keep your fingers crossed - - kick the bucket - - kick up your heels - - kick your feet up - - kid in a candy store - - kill two birds with one stone - - kiss of death - - knock it out of the park - - knock on wood - - knock your socks off - - know him from Adam - - know the ropes - - know the score - - knuckle down - - knuckle sandwich - - knuckle under - - labor of love - - ladder of success - - land on your feet - - lap of luxury - - last but not least - - last hurrah - - last-ditch effort - - law of the jungle - - law of the land - - lay down the law - - leaps and bounds - - let sleeping dogs lie - - let the cat out of the bag - - let the good times roll - - let your hair down - - let's talk turkey - - let's touch base - - letter perfect - - lick your wounds - - lies like a rug - - life's a bitch - - life's a grind - - light at the end of the tunnel - - lighter than a feather - - lighter than air - - like clockwork - - like father like son - - like taking candy from a baby - - like there's no tomorrow - - lion's share - - live and learn - - live and let live - - long and short of it - - long lost love - - look before you leap - - look down your nose - - look what the cat dragged in - - looking a gift horse in the mouth - - looks like death warmed over - - loose cannon - - lose your head - - lose your temper - - loud as a horn - - lounge lizard - - loved and lost - - low man on the totem pole - - low-hanging fruit - - luck of the draw - - luck of the Irish - - make hay while the sun shines - - make money hand over fist - - make my day - - make the best of a bad situation - - make the best of it - - make your blood boil - - man of few words - - man's best friend - - mark my words - - meaningful dialogue - - missed the boat on that one - - moment in the sun - - moment of glory - - moment of truth - - money to burn - - more power to you - - more than one way to skin a cat - - move the goal post - - movers and shakers - - moving experience - - naked as a jaybird - - naked truth - - neat as a pin - - needle in a haystack - - needless to say - - neither here nor there - - never look back - - never say never - - nip and tuck - - nip it in the bud - - no brainer - - no guts, no glory - - no love lost - - no pain, no gain - - no skin off my back - - no stone unturned - - no time like the present - - no use crying over spilled milk - - nose to the grindstone - - not a hope in hell - - not a minute's peace - - not in my backyard - - not playing with a full deck - - not the end of the world - - not written in stone - - nothing to sneeze at - - nothing ventured nothing gained - - now we're cooking - - off the top of my head - - off the wagon - - off the wall - - old hat - - older and wiser - - older than dirt - - older than Methuselah - - on a roll - - on cloud nine - - on my plate - - on pins and needles - - on the bandwagon - - on the money - - on the nose - - on the rocks - - on the spot - - on the tip of my tongue - - on the wagon - - on thin ice - - once bitten, twice shy - - one bad apple doesn't spoil the bushel - - one born every minute - - one brick short - - one foot in the grave - - one in a million - - one red cent - - only game in town - - open a can of worms - - open and shut case - - open the flood gates - - opportunity doesn't knock twice - - out of pocket - - out of sight, out of mind - - out of the frying pan into the fire - - out of the woods - - out on a limb - - over a barrel - - over the hump - - pain and suffering - - pain in the - - panic button - - par for the course - - part and parcel - - party pooper - - pass the buck - - patience is a virtue - - pay through the nose - - penny pincher - - perfect storm - - pig in a poke - - pile it on - - pillar of the community - - pin your hopes on - - ping me - - pitter patter of little feet - - plain as day - - plain as the nose on your face - - play by the rules - - play your cards right - - playing the field - - playing with fire - - pleased as punch - - plenty of fish in the sea - - point with pride - - poor as a church mouse - - pot calling the kettle black - - pretty as a picture - - pull a fast one - - pull your punches - - pulling your leg - - pure as the driven snow - - put it in a nutshell - - put one over on you - - put the cart before the horse - - put the pedal to the metal - - put your best foot forward - - put your foot down - - quick as a bunny - - quick as a lick - - quick as a wink - - quick as lightning - - quiet as a dormouse - - rags to riches - - raining buckets - - raining cats and dogs - - rank and file - - rat race - - reap what you sow - - red as a beet - - red herring - - reinvent the wheel - - rich and famous - - rings a bell - - ripe old age - - ripped me off - - rise and shine - - road to hell is paved with good intentions - - rob Peter to pay Paul - - roll over in the grave - - rub the wrong way - - ruled the roost - - running in circles - - sad but true - - sadder but wiser - - salt of the earth - - scared stiff - - scared to death - - sealed with a kiss - - second to none - - see eye to eye - - seen the light - - seize the day - - set the record straight - - set the world on fire - - set your teeth on edge - - sharp as a tack - - shoot for the moon - - shoot the breeze - - shot in the dark - - shoulder to the wheel - - sick as a dog - - sigh of relief - - signed, sealed, and delivered - - sink or swim - - six of one, half a dozen of another - - skating on thin ice - - slept like a log - - slinging mud - - slippery as an eel - - slow as molasses - - smart as a whip - - smooth as a baby's bottom - - sneaking suspicion - - snug as a bug in a rug - - sow wild oats - - spare the rod, spoil the child - - speak of the devil - - spilled the beans - - spinning your wheels - - spitting image of - - spoke with relish - - spread like wildfire - - spring to life - - squeaky wheel gets the grease - - stands out like a sore thumb - - start from scratch - - stick in the mud - - still waters run deep - - stitch in time - - stop and smell the roses - - straight as an arrow - - straw that broke the camel's back - - strong as an ox - - stubborn as a mule - - stuff that dreams are made of - - stuffed shirt - - sweating blood - - sweating bullets - - synergy - - take a load off - - take one for the team - - take the bait - - take the bull by the horns - - take the plunge - - take this offline - - takes one to know one - - takes two to tango - - the more the merrier - - the real deal - - the real McCoy - - the red carpet treatment - - the same old story - - there is no accounting for taste - - thick as a brick - - thick as thieves - - thin as a rail - - think outside of the box - - think outside the box - - third time's the charm - - this day and age - - this hurts me worse than it hurts you - - this point in time - - three sheets to the wind - - through thick and thin - - throw in the towel - - thrown under the bus - - tie one on - - tighter than a drum - - time and time again - - time is of the essence - - tip of the iceberg - - tired but happy - - to coin a phrase - - to each his own - - to make a long story short - - to the best of my knowledge - - toe the line - - tongue in cheek - - too good to be true - - too hot to handle - - too numerous to mention - - touch with a ten foot pole - - tough as nails - - trial and error - - trials and tribulations - - tried and true - - trip down memory lane - - twist of fate - - two cents worth - - two peas in a pod - - ugly as sin - - under the counter - - under the gun - - under the same roof - - under the weather - - until the cows come home - - unvarnished truth - - up the creek - - uphill battle - - upper crust - - upset the applecart - - vain attempt - - vain effort - - vanquish the enemy - - vested interest - - waiting for the other shoe to drop - - wakeup call - - warm welcome - - watch your p's and q's - - watch your tongue - - watching the clock - - water under the bridge - - weather the storm - - weed them out - - week of Sundays - - went belly up - - wet behind the ears - - what goes around comes around - - what you see is what you get - - when it rains, it pours - - when push comes to shove - - when the cat's away - - when the going gets tough, the tough get going - - white as a sheet - - whole ball of wax - - whole hog - - whole nine yards - - wild goose chase - - will wonders never cease? - - win-win - - wisdom of the ages - - wise as an owl - - wolf at the door - - words fail me - - work like a dog - - world weary - - worst nightmare - - worth its weight in gold - - wrong side of the bed - - yanking your chain - - yappy as a dog - - years young - - you are what you eat - - you can run but you can't hide - - you only live once - - you're the boss - - young and foolish - - young and vibrant \ No newline at end of file diff --git a/styles/NGINX/Foreign.yml b/styles/NGINX/Foreign.yml deleted file mode 100644 index ad8f375b2..000000000 --- a/styles/NGINX/Foreign.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -ignorecase: true -level: error -nonword: true -action: - name: replace -swap: - '\b(?:eg|e\.g\.)[\s,]': for example - '\b(?:ie|i\.e\.)[\s,]': that is - '\b(?:etc|etc\.)[\s,]': and so on \ No newline at end of file diff --git a/styles/NGINX/Naming.yml b/styles/NGINX/Naming.yml deleted file mode 100644 index 27f4f8bab..000000000 --- a/styles/NGINX/Naming.yml +++ /dev/null @@ -1,26 +0,0 @@ -extends: substitution -message: Make sure to use the full name '%s' instead of the short name '%s'. -action: - name: replace -level: error -#code: false -ignorecase: false -swap: - ACM: NGINX API Connectivity Manager - ADM: NGINX App Delivery Manager - Amplify: NGINX Amplify - App Protect: NGINX App Protect - '(?:Dev Central|DC|dc|dev central|devCentral)': DevCentral - '(?:big-ip|BigIp|Big-IP|Big IP|Big Ip|BIGIp)': BIG-IP - '(?:big-iq|BigIq|Big-IQ|Big IQ|Big Iq|BIGIq)': BIG-IQ - F5 Networks: F5, Inc. - Controller: NGINX Controller - '(?:NIC|Ingress Controller)': NGINX Ingress Controller - nginx: NGINX - '(?:nginx\+|NGINX\+|N\+)': NGINX Plus - '(?:oss|OSS)': NGINX OSS - NIM: NGINX Instance Manager - NSM: NGINX Service Mesh - NMS: NGINX Management Suite - Unit: NGINX Unit - diff --git a/styles/NGINX/Spelling.yml b/styles/NGINX/Spelling.yml deleted file mode 100644 index c8baf4bef..000000000 --- a/styles/NGINX/Spelling.yml +++ /dev/null @@ -1,5 +0,0 @@ -extends: spelling -message: "Spelling error: '%s'." -level: error -code: false -ignorecase: true \ No newline at end of file diff --git a/styles/NGINX/Terms.yaml b/styles/NGINX/Terms.yaml new file mode 100644 index 000000000..f381afbd9 --- /dev/null +++ b/styles/NGINX/Terms.yaml @@ -0,0 +1,6 @@ +extends: substitution +message: Consider using '%s' instead of '%s' +level: warning +ignorecase: false +swap: + hostname: host name \ No newline at end of file diff --git a/styles/NGINX/WordChoice.yml b/styles/NGINX/WordChoice.yml deleted file mode 100644 index 28e770c80..000000000 --- a/styles/NGINX/WordChoice.yml +++ /dev/null @@ -1,148 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -ignorecase: false -#code: false -level: suggestion -action: - name: replace -swap: - above: preceding|previous - '(?:anti-virus|anti virus)': antivirus - api: API - '(?:AskF5 Knowledgebase|AskF5 portal)': AskF5 - authorisation: authorization - '(?:black list|blacklist|blacklisted)': blocklist|block list|deny list|denylisted - backwards: backward - '(?:bare metal|on-prem)': private cloud - baz: a real-world example - below: following - blade: panel - '(?:boot|boot up|reboot)': start|restart - BIG-IPs: BIG-IP systems - cachable: cacheable - cacheing: caching - card holder: cardholder - case-insensitive: not case-sensitive - check: verify|confirm|test|ensure - checkbox: check box - cli: CLI - click: select - client side: hyphenate as client-side when used as adjective - cloud native: cloud-native - cloud ready: cloud-ready - colour: color - configure: set - core: don't use as a verb - core dump: core file - coreos: CoreOS - controlplane: control plane - '(?:cyber-attack|cyberattack)': cyber attack - '(?:crash|crashes|crashed)': stops responding|shuts down|system restarts - data are: data is - datacenter: data center - dataplane: data plane - datastore: datastor - de-duplicate: deduplicate - de-duplication: deduplication - '(?:demilitarized zone|DMZ)': perimeter network - dev: developer|development - dialog box: pop-up window|pop-up screen - '(?:drop-down|dropdown|drop-down box)': list - e-mail: email - enable: use a stronger verb if possible - '(?:end point|end-point)': endpoint - end-user: user - '(?:hand held|hand-held)': handheld - '(?:hair pinning|hair-pinning)': hairpinning - env: environment - etcetera: and so on - executables: system files - execute: use|enter|start|run - extraneous: extra|unneeded - Extranet: extranet - F5 Technical Support: F5 Support - filename: file name - forward slash: slash - forwards: forward - grayed out: unavailable - grpc: GRPC - '(?:GUI|WebGUI|WebUI|UI)': user interface|browser interface - hacker: malicious user - hang: fail to respond|become unavailable - homepage: home page - hostname: host name - hot fix: hotfix - '(?:hover on|hover in)': hover over - impact: affect - input: don't use as a verb; use type instead - Internet: internet - Intranet: intranet - jaeger: Jaeger - jwt: JWT - '(?:K8s|k8s|kubernetes)': Kubernetes - leverage: use - list box: box - load-balance: load balance - load-balancer: load balancer - load-balancing: load balancing - lower case: lowercase - master: primary|principal|control|main - mouse: cursor - mouse over: hover over - multi layer: multi-layer - '(?:micro-service|micro service)': microservice - '(?:multicloud|multi cloud)': multi-cloud - '(?:multilayer|multi layer)': multi-layer - '(?:multitenancy|multi tenancy)': multi-tenancy - '(?:nameserver|name-server)': name server - name space: namespace - net: network - netmask: network mask - NGINX Technical Support: NGINX Support - '(?:off-load|off load)': offload - '(?:plugin|plug in)': plug-in - '(?:readonly|read only)': read-only - openapi: OpenAPI - path name: path|file name - pem: PEM - pfx: PFX - pkcs: PKCS - pointer: cursor - power off: shut down - prometheus: Prometheus - query: get|list - radio button: refer to the item by its label - rbac: RBAC - repo: repository - reprovision: re-provision - roadmap: road map - rpc: RPC - shortcut menu: menu - slave: secondary|replica|agent|worker - smart phone: smartphone - smartcard: smart card - spin down: remove - spin up: create - subdir: subdirectory - '(?:thruput|through put)': throughput - text box: box - timeframe: time frame - tool set: toolset - touch screen: touchscreen - uncheck: deselect - url: URL - user name: username - userID: user ID - utilize: use - via: by means of|through - vice versa: conversely - '(?:virtual IP|VIP)': virtual address - web site: website - webpage: web page - webserver: web server - '(?:white list|whitelist|whitelisted)': allowlist|allow list|allowlisted - '(?:wifi|WiFi)': Wi-Fi - '(?:window|screen)': page - '(?:wish|desire)': want|need|require|prefer - yaml: YAML - zipkin: Zipkin diff --git a/styles/Vocab/NGINXNouns/accept.txt b/styles/Vocab/NGINXNouns/accept.txt deleted file mode 100644 index 5beff3a59..000000000 --- a/styles/Vocab/NGINXNouns/accept.txt +++ /dev/null @@ -1,142 +0,0 @@ -api -API -apigw -APIs -apis -autoscale -bck -cacert -cfg -cgroup -Cgroup -CLI -cmd -coredns -coreos -config -configs -CSR -csharp -datastore -datastor -denylist -denylisting -Denylist -Denylisting -dev -Dev -devportal -dev-portal -dll -Docker -Dockerfile -downsampled -downsample -eml -enum -etcd -exe -f5net -GRPC -GitHub -GitLab -GitSwarm -gitlab -gitswarm -Grafana -grpc -gzip -healthz -host -hostname -hta -htr -htw -http -https -HTTP -HTTPS -ida -idc -idq -img -ini -injectable -io -Jenkinsfile -jpg -jpeg -Joomla -joomla -json -jwt -keepalive -kubeadm -kubeconfig -kubectl -Kubelet -kubelet -kubernetes -md -meshctl -namespace -namespaces -nginx -nginx-meshctl -ngx -objc -openapi -opentracing -pem -pfx -pkcs -PKCS -png -PNG -productpage -prometheus -proto -protoc -protobuf -psql -psutil -repo -revalidate -revalidated -rcvd -ref -relref -rpc -RPC -runtime -runtimes -semver -servlets -Servlets -smi -src -ssl -stdin -stdout -subdir -subnet -svc -syslog -timeframe -Timeframe -ttfb -unavail -unencrypted -unmute -Unmute -unparsable -URIs -URI -waf -WAF -walkthrough -webserver -yaml -YAML -Zipkin -zipkin \ No newline at end of file diff --git a/styles/Vocab/NGINXNouns/reject.txt b/styles/Vocab/NGINXNouns/reject.txt deleted file mode 100644 index 93fea7a4c..000000000 --- a/styles/Vocab/NGINXNouns/reject.txt +++ /dev/null @@ -1,109 +0,0 @@ -abort -abortion -alameda -aluminum -apollo -argon -armstrong -asshole -at&t -atlantis -attacker -badger -barkan -beryllium -bitch -blacklist -bourne -calcite -carbon -cascade -centaur -cerberus -cesium -cheetah -chougar -chromium -columbia -corona -costco -cougar -d-alcite -dammit -damn -danburite -daytona -deschutes -diamond -disan -discoveryplatform -dolomite -douche -draco -drycreek -dvora -endeavour -equinox -evergreen -exploit -fidelity -firebolt -firestone -flyout -foo -foobar -foobar -fu -fubar -fubar -fuck -gemini -greenflash -greenflash -hacker -hsibj -ironside -joffre -jpmc -kill -linecard -master -mercury -moonshot -octeon -olivia -parkcity -pathological -please -predator -puma -quasar -redmountain -scorpion -shit -shuttle -slave -solar -solstice -somevar -sonoma -stagsleap -stirling -stratos -techmatrix -terminate -thankyou -threat -tokyo -treadstone -trident -vancouver -verizon -vic1 -vic2 -vicii -victoria -vzw -whitelist -whitethorne -zenith \ No newline at end of file diff --git a/styles/config/vocabularies/Kubernetes/accept.txt b/styles/config/vocabularies/Kubernetes/accept.txt new file mode 100644 index 000000000..d48a99d30 --- /dev/null +++ b/styles/config/vocabularies/Kubernetes/accept.txt @@ -0,0 +1,7 @@ +(?i)containerPort +Gateway API +Helm +HTTPRoute +kubectl +namespace +(?i)nodePort \ No newline at end of file diff --git a/styles/config/vocabularies/NGINX/accept.txt b/styles/config/vocabularies/NGINX/accept.txt new file mode 100644 index 000000000..99a4c11e1 --- /dev/null +++ b/styles/config/vocabularies/NGINX/accept.txt @@ -0,0 +1,3 @@ +API +(?i)NGINX +ghcode \ No newline at end of file