Skip to content

Commit 18cfe23

Browse files
committed
Edits
1 parent e949062 commit 18cfe23

File tree

3 files changed

+5
-135
lines changed

3 files changed

+5
-135
lines changed

contribute-docs/style-guide/accessibility.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -239,18 +239,5 @@ not its primary meaning. Other types of words and phrases best avoided are:
239239
* violent imagery (_crush the competition_)
240240
* non-specific superlatives (_unrivaled_, _unparalleled_, _world class_)
241241

242-
Some words have nuances that fall into the above categories, which may cause
243-
them to be misinterpreted. Here are some suggested alternatives:
244-
245-
| Avoid | Use instead |
246-
| ----- | ------------|
247-
| Abort | Stop, cancel, end |
248-
| Boot | Start, run |
249-
| Execute | Run, complete |
250-
| Hack (noun) | Tip, workaround |
251-
| Hack (verb) | Configure, modify |
252-
| Hit (verb) | Click, press |
253-
| Hit (noun) | Visits (as in "website visits") |
254-
| Invalid | Not valid, incorrect |
255-
| Kill | Cancel, stop |
256-
| Terminate | Stop, exit |
242+
Some words have nuances that fall into the above categories, which might cause
243+
them to be misinterpreted. For a full list, refer to [Word choice](word-choice.md).

contribute-docs/style-guide/formatting.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -199,17 +199,6 @@ To separate staging and production APM data, we need to create six filtered alia
199199
| Error | `production-logs-apm` | `staging-logs-apm` |
200200
| Span/transaction | `production-traces-apm` | `staging-traces-apm` |
201201
| Metrics | `production-metrics-apm` | `staging-metrics-apm` |
202-
203-
---
204-
205-
Go to **Project Settings** to manage your connectors, data views, and other features.
206-
207-
| API keys | Create and manage keys that can send requests on behalf of users. | * Elasticsearch * Observability * Security |
208-
| --- | --- | --- |
209-
| Asset criticality | Bulk assign asset criticality to multiple entities by importing a text file. | Security |
210-
| Connectors | Create and manage reusable connectors for triggering actions. | * Elasticsearch * Observability * Security |
211-
| Data views | Manage the fields in the data views that retrieve your data from ((es)). | * Elasticsearch * Observability * Security |
212-
213202

214203
:::
215204

contribute-docs/style-guide/seo.md

Lines changed: 3 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,9 @@ Best practices:
109109
* Keep it actionable
110110
* If the page is a how-to or guide, indicate the action or outcome.
111111

112-
**⚠️Note:** Within the context of the "introductory paragraph", the first and/or second sentence is used in the meta description tag, up to the first 150-160 characters. This tag appears on the search engines results page and impacts CTR. It is not directly user-facing otherwise.
112+
:::{note}
113+
If the description is missing in the frontmatter, the first sentences of the page are used in the meta description tag, up to the first 150-160 characters. This tag appears on the search engines results page and impacts CTR. It is not directly user-facing otherwise.
114+
:::
113115

114116
When a page starts with a note, image, table, or other component, the meta description is *not* impacted by the component content. Only the first paragraph content nested within the first lines of the opening paragraph tags `<p\>\</p\>`) impact the meta description.
115117

@@ -459,111 +461,3 @@ Best practices:
459461

460462
* Hreflang tags signal language and region to search engines in order to surface and index them within respective search results.
461463
* Consult with the documentation team for implementation guidance. External contributors should open a GitHub issue to discuss hreflang implementation.
462-
463-
## Elastic Docs SEO checklist
464-
465-
### Headings [checklist-headings]
466-
467-
- [ ] H1 is unique, concise, & clearly states the page's main topic or purpose
468-
- [ ] Only one H1 is used per page
469-
- [ ] H1 includes the primary keyword & matches the page focus
470-
- [ ] H2s break content into logical, descriptive sections
471-
- [ ] H2s & H3s are unique, not vague or duplicative
472-
- [ ] Headings use proper order & hierarchy
473-
- [ ] Headings reflect the content that follows
474-
- [ ] Headings are not used solely for styling
475-
476-
### Introductory paragraph [checklist-intro]
477-
478-
- [ ] First paragraph summarizes the page in 1–3 sentences
479-
- [ ] States what users will learn or accomplish
480-
- [ ] Naturally includes primary & secondary keywords
481-
- [ ] Addresses user intent & context
482-
- [ ] Uses clear, plain language (defines jargon if needed)
483-
- [ ] First sentence is suitable for meta description (concise, relevant, actionable)
484-
485-
### Body copy [checklist-body]
486-
487-
- [ ] Uses accurate technical terminology; defines terms on first use
488-
- [ ] Written clearly & concisely
489-
- [ ] Uses active voice & direct instructions
490-
- [ ] Keywords & related terms are incorporated naturally
491-
- [ ] Content is organized with logical headings & subheadings
492-
- [ ] Provides unique value (not thin or duplicate content)
493-
- [ ] Includes examples, code snippets, or visuals where helpful
494-
- [ ] Uses bullet points, numbered lists, & callouts for scannability
495-
- [ ] Structured data is added where applicable (consult engineering if unsure)
496-
- [ ] Links to related documentation or authoritative external sources
497-
- [ ] Content is up-to-date & regularly reviewed
498-
499-
### Content length and structure
500-
501-
- [ ] Content fully answers the user's question or task (not padded or too brief)
502-
- [ ] Long topics are broken into focused, navigable pages
503-
- [ ] Paragraphs are short & easy to scan
504-
- [ ] Visual breaks (callouts, asides) are used for emphasis, but not overused
505-
506-
### Lists [checklist-lists]
507-
508-
- [ ] Lists use the correct type (bulleted for unordered, numbered for steps)
509-
- [ ] List items are concise, parallel, & consistent
510-
- [ ] Lead-in sentence introduces each list
511-
- [ ] Lists are not excessively long or nested
512-
513-
### Interlinking (internal and external links) [checklist-interlink]
514-
515-
- [ ] Anchor text is descriptive & meaningful
516-
- [ ] Internal links guide users to related or deeper documentation
517-
- [ ] External links point to reputable, relevant sources & open in a new tab
518-
- [ ] No broken or outdated links
519-
- [ ] Links are not excessive or distracting
520-
- [ ] Link text is visually distinguishable & accessible
521-
522-
### Multimedia (images and video) [checklist-multimedia]
523-
524-
- [ ] Visuals (images, diagrams, videos) directly support the content
525-
- [ ] Images are unique, high-quality, & not stock photos
526-
- [ ] Image file names are descriptive, lowercase, & use hyphens
527-
- [ ] Images are compressed/optimized for web
528-
- [ ] Alt text accurately describes each image's purpose
529-
- [ ] No important text is embedded in images
530-
- [ ] Videos are relevant, compressed, & include captions/transcripts
531-
- [ ] Visuals are referenced in the body copy
532-
- [ ] Third-party visuals are properly attributed
533-
- [ ] Structured data is used for multimedia where possible
534-
535-
### URLs [checklist-urls]
536-
537-
- [ ] URL is short, descriptive, & reflects the page's topic
538-
- [ ] Uses lowercase letters & hyphens (no spaces, underscores, or special characters)
539-
- [ ] URL structure mirrors the documentation hierarchy (`/docs/section/topic/`)
540-
- [ ] Each child page has a valid parent page
541-
- [ ] URL matches the H1 & page focus
542-
- [ ] Canonical tag is set to the preferred URL
543-
544-
### Meta keywords tag [checklist-keywords]
545-
546-
- [ ] No more than 5 unique, relevant keywords (comma-separated)
547-
- [ ] No repetition or duplication
548-
- [ ] Keywords are specific to the page topic
549-
550-
### Content updates and maintenance [checklist-updates]
551-
552-
- [ ] Content is reviewed regularly for accuracy & relevance
553-
- [ ] Versioning is clearly indicated where applicable
554-
- [ ] Redirects are set up for removed or merged pages
555-
- [ ] User feedback is reviewed & acted on
556-
557-
### Mobile performance and usability [checklist-mobile]
558-
559-
- [ ] Pages are tested on various mobile devices
560-
- [ ] All features, navigation, & media are visible & functional on mobile
561-
- [ ] Text is readable & interactive elements are easy to tap
562-
- [ ] Images & media are optimized for fast mobile loading
563-
- [ ] No horizontal scrolling is required
564-
565-
### Final content review [checklist-final]
566-
567-
- [ ] Checklist items have been reviewed
568-
- [ ] Content is written with the user in mind
569-
- [ ] Content is enhanced for search engine "readability"

0 commit comments

Comments
 (0)