diff --git a/nf-style-guide.md b/nf-style-guide.md index 845d696..6770e8e 100644 --- a/nf-style-guide.md +++ b/nf-style-guide.md @@ -12,6 +12,7 @@ scan, and they build user trust. - Use active voice when possible, especially for how-tos. - Use everyday language. Be direct and conversational. Use contractions freely. Use technical terms accurately but avoid unnecessary industry jargon or slang that can confuse non-experts. +- Write plainly: simple sentence structure, precise technical terms, no literary punctuation, no cleverness. - Use [screenshots](#images-and-file-names) compatible with mobile devices. - Avoid pronouns but use 'you' and 'your' when needed, not "the user". @@ -144,9 +145,9 @@ The exact top-level buckets we use for the ToC can vary depending on the product ## Punctuation -- Use hyphens for compound adjectives. Em dashes (`—`) are okay but use sparingly—prefer colons when introducing or - defining items. Spaces around em dashes are optional; both `word—word` and `word — word` are acceptable. Be consistent - within a document. +- Use hyphens for compound adjectives. +- **Avoid em dashes.** Rewrite as a separate sentence, or use a colon to introduce or define and a comma for an aside. + If an em dash is genuinely unavoidable, put spaces around it: `word — word`, never `word—word`. - Use colons to introduce or define items. - Use oxford commas. - **Slashes**: no spaces around a slash joining single words (`Debian/Ubuntu`, `TCP/UDP`, `on/off`). Use spaces when diff --git a/unified-doc/docusaurus.config.ts b/unified-doc/docusaurus.config.ts index eeedf61..edf8da8 100644 --- a/unified-doc/docusaurus.config.ts +++ b/unified-doc/docusaurus.config.ts @@ -23,7 +23,7 @@ import { import {PublishConfig} from 'src/components/docusaurus' import {zrokDocsPluginConfig, zrokRedirects} from "./_remotes/zrok/website/docusaurus-plugin-zrok-docs.ts"; import {onpremRedirects} from "./_remotes/selfhosted/docusaurus/docusaurus-plugin-onprem-docs.ts"; -import {platformDocsPluginConfig} from "./_remotes/platform/docusaurus/docusaurus-plugin-platform-docs.ts"; +import {platformDocsPluginConfig, platformRedirects} from "./_remotes/platform/docusaurus/docusaurus-plugin-platform-docs.ts"; import {openzitiDocsPluginConfig, openzitiRedirects} from "./_remotes/openziti/docusaurus/docusaurus-plugin-openziti-docs.ts"; import {dataconnectorDocsPluginConfig} from "./_remotes/data-connector/docusaurus/docusaurus-plugin-dataconnector-docs.ts"; @@ -480,6 +480,7 @@ const config: Config = { build(BUILD_FLAGS.OPENZITI) && openzitiRedirects(routeBase('openziti')), build(BUILD_FLAGS.SELFHOSTED) && onpremRedirects(routeBase('selfhosted')), build(BUILD_FLAGS.ZROK) && zrokRedirects(routeBase('zrok')), + build(BUILD_FLAGS.PLATFORM) && platformRedirects(routeBase('platform')), build(BUILD_FLAGS.OPENZITI) && ['@scalar/docusaurus', { id: 'edge-client', label: 'Edge Client API reference', diff --git a/unified-doc/scripts/check-sitemap-drift.mjs b/unified-doc/scripts/check-sitemap-drift.mjs index 743a68b..e440251 100644 --- a/unified-doc/scripts/check-sitemap-drift.mjs +++ b/unified-doc/scripts/check-sitemap-drift.mjs @@ -91,6 +91,7 @@ const PRODUCTS = [ { prefix: '/docs/selfhosted', name: 'selfhosted', repo: 'k8s-on-prem-installations', fn: 'selfhostedRedirects()' }, { prefix: '/docs/frontdoor', name: 'frontdoor', repo: 'frontdoor', fn: 'frontdoorRedirects()' }, { prefix: '/docs/zlan', name: 'zlan', repo: 'zlan', fn: 'zlanRedirects()' }, + { prefix: '/docs/platform', name: 'platform', repo: 'platform-doc', fn: 'platformRedirects()' }, ]; function productFor(p) {