Skip to content

Commit

Permalink
Fix spelling of "front matter"
Browse files Browse the repository at this point in the history
  • Loading branch information
errose28 committed Mar 5, 2024
1 parent 4f6f7ed commit c785de5
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Docusaurus provides many options for laying out documentation pages and their me

- File names and therefore generated URLs should all be `kebab-case`.

- Let Docusaurus automatically generate the page's title from its top level markdown heading instead of using `title` in the frontmatter. This is different from the sidebar label or URL slug.
- Let Docusaurus automatically generate the page's title from its top level markdown heading instead of using `title` in the front matter. This is different from the sidebar label or URL slug.

- Use relative file paths for all links between pages.
- This keeps page links pointing to the current version of the documentation.
Expand Down Expand Up @@ -129,7 +129,7 @@ Docusaurus provides many options for laying out documentation pages and their me
Object Store Bucket Layout
```

- Sidebar labels are automatically generated from page titles. To use a different sidebar label, use the `sidebar_label` property in the page's frontmatter.
- Sidebar labels are automatically generated from page titles. To use a different sidebar label, use the `sidebar_label` property in the page's front matter.

- Don't rely on Ozone specific acronyms in the sidebar. This makes docs navigation more beginner friendly.
- For example, the pages on bucket layouts may be organized as:
Expand Down Expand Up @@ -178,7 +178,7 @@ The file names and content of all markdown pages are checked for spelling mistak

- Option 1: If the word is relevant for the whole Ozone project, add it to the `words` list in *cspell.yaml* so that it is considered valid.

- Option 2: If the word is only relevant for one specific page, add an [inline directive](https://cspell.org/configuration/document-settings/) as a comment in the markdown frontmatter of that page only.
- Option 2: If the word is only relevant for one specific page, add an [inline directive](https://cspell.org/configuration/document-settings/) as a comment in the markdown front matter of that page only.

### Updating Graphics

Expand Down
1 change: 0 additions & 1 deletion cspell.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ words:
- gpg
- sed
- mds
- frontmatter
- javadoc
# Misc words
- acking
Expand Down
4 changes: 2 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ const config = {
markdown: {
// Validate markdown frontmatter against a more restrictive schema than what Docusaurus allows.
// This ensures all pages are using a minimal set of consistent keys.
// It can also be used to require all pages to define certain markdown frontmatter keys.
// It can also be used to require all pages to define certain markdown front matter keys.
parseFrontMatter: async (params) => {
// Reuse the default parser.
const result = await params.defaultParseFrontMatter(params);

// Validate frontmatter against the schema.
// Validate front matter against the schema.
const schemaPath = './.github/resource/frontmatter.schema.json';
const frontMatterSchema = require(schemaPath);
const ajv = new Ajv();
Expand Down

0 comments on commit c785de5

Please sign in to comment.