Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove 'title' frontmatter and improve title handling logic #196

Merged
merged 7 commits into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ jobs:
# we run our artifact directly please use the prebuild
# elastic/docs-builder@main GitHub Action for all other repositories!
- name: Build documentation
run: .artifacts/publish/docs-builder/release/docs-builder
run: .artifacts/publish/docs-builder/release/docs-builder --strict
4 changes: 1 addition & 3 deletions docs/source/configure/content-set/attributes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
---
title: Attributes
---
# Attributes

tbd
4 changes: 1 addition & 3 deletions docs/source/configure/content-set/file-structure.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
---
title: File structure
---
# File structure

tbd
3 changes: 2 additions & 1 deletion docs/source/configure/content-set/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Content set configuration
navigation_title: Content set
---

# Content set configuration

Now we'll zoom into the AsciiDoc book level, and explore the V3 equivalent: content sets. At the book level, the system consists of:

| System property | Asciidoc | V3 |
Expand Down
4 changes: 1 addition & 3 deletions docs/source/configure/content-set/navigation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
---
title: Navigation
---
# Navigation

tbd
3 changes: 2 additions & 1 deletion docs/source/configure/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Configure Elastic Docs
navigation_title: Configuration reference
---

# Configure Elastic Docs

* [Page configuration](./page.md)
* [Content-set configuration](./content-set/index.md)
* [Site configuration](./site/index.md)
3 changes: 2 additions & 1 deletion docs/source/configure/page.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Page configuration
navigation_title: Page
---

# Page configuration

tbd

go into frontmatter here?
Expand Down
4 changes: 1 addition & 3 deletions docs/source/configure/site/content.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Content config
---
# Content config

In both the AsciiDoctor- and V3-based system, there is site-wide configuration where you list all content sources, where to find those sources, and in what order they should be added to the site.

Expand Down
3 changes: 2 additions & 1 deletion docs/source/configure/site/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Site configuration
navigation_title: Site
---

# Site configuration

Start by understanding how the new V3 system works at the site level compared to how our custom AsciiDoctor system works. The system consists of:


Expand Down
4 changes: 1 addition & 3 deletions docs/source/configure/site/landing-page.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
---
title: Landing page
---
# Landing page

tbd
4 changes: 1 addition & 3 deletions docs/source/configure/site/redirects.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Redirects
---
# Redirects

## From an elastic.co/guide page

Expand Down
4 changes: 1 addition & 3 deletions docs/source/configure/site/shared-attributes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Shared attributes
---
# Shared attributes

To promote consistency across documentation, AsciiDoc uses shared attributes for common terms, URLs, and versions.

Expand Down
3 changes: 2 additions & 1 deletion docs/source/contribute/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Elastic Docs contribution guide
navigation_title: Contribute
---

# Elastic Docs contribution guide

Welcome, **contributor**!

Whether you're a technical writer or you've only edited Elastic docs once or twice, you're a valued contributor. Every word matters!
Expand Down
4 changes: 1 addition & 3 deletions docs/source/contribute/locally.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Contribute locally
---
# Contribute locally

Follow these steps to contribute to Elastic docs.
* [Step 1: Install `docs-builder`](#step-one)
Expand Down
4 changes: 1 addition & 3 deletions docs/source/contribute/on-the-web.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Contribute on the web
---
# Contribute on the web

1. On the right side of the page you want to edit, select **Edit this page**.
1. Do something on GitHub.
Expand Down
3 changes: 2 additions & 1 deletion docs/source/development/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Development Guide
navigation_title: Development
---

# Development Guide

TODO write development documentation here
4 changes: 1 addition & 3 deletions docs/source/development/link-validation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Link validation
---
# Link validation

* See the [RFC](https://docs.google.com/document/d/1fZNeJCVLKu19s4WIKkkqrHyE9YlWQHNed94Y_V7ofRI/edit?tab=t.0#heading=h.z8tixe192fr4).
* Infrastructure lives in [docs-infra](https://github.com/elastic/docs-infra).
Expand Down
4 changes: 1 addition & 3 deletions docs/source/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Welcome to Elastic Docs v3
---
# Welcome to Elastic Docs v3

Elastic Docs V3 is our next-generation documentation platform designed to improve the experience of learning, using, and contributing to Elastic products. Built on a foundation of modern authoring tools and scalable infrastructure, V3 offers faster builds, streamlined versioning, and enhanced navigation to guide users through Elastic’s complex ecosystem.

Expand Down
4 changes: 1 addition & 3 deletions docs/source/migration/engineering.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Reference docs guidelines
---
# Reference docs guidelines

## Engineering ownership of reference documentation

Expand Down
4 changes: 1 addition & 3 deletions docs/source/migration/freeze/gh-action.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: GH Action
---
# GH Action

## Overview
This GitHub Action enforces documentation freezes by adding comments to pull requests that modify `.asciidoc` files. It complements the use of `CODEOWNERS` to ensure changes during a freeze period are reviewed and approved by the `@docs-freeze-team`.
Expand Down
4 changes: 1 addition & 3 deletions docs/source/migration/freeze/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Documentation Freeze
---
# Documentation Freeze

During the documentation freeze, the Docs team will focus almost entirely on migration tasks to ensure all content is successfully migrated and will handle only emergency documentation requests and release-related activities. When the migration is complete, writers will address documentation requests needed during the documentation freeze, ensuring that updates align with the new information architecture and format.

Expand Down
4 changes: 1 addition & 3 deletions docs/source/migration/guide/file-structure.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: File structure
---
# File structure

In both the AsciiDoc- and V3-based systems, file structure is largely independent from the resulting site navigation.

Expand Down
4 changes: 1 addition & 3 deletions docs/source/migration/guide/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Migration Guide
---
# Migration Guide

How to migrate content from Asciidoc to V3.

Expand Down
3 changes: 2 additions & 1 deletion docs/source/migration/guide/mapping.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Book to content set mapping
navigation_title: What books are migrating
---

# Book to content set mapping

What full books are staying in Asciidoc? What books are migrating `main`/`master`? See the table below.

| Title | Current Version | Sources | Migrate to |
Expand Down
3 changes: 2 additions & 1 deletion docs/source/migration/ia.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Improved information architecture
navigation_title: New IA
---

# Improved information architecture

The improved information architecture fundamentally transforms how we organize and present Elastic Docs. By addressing longstanding challenges—such as fragmented content across many books and duplicated information—this new structure introduces a cohesive framework that emphasizes clarity, usability, and alignment with user goals. These updates are designed to create a seamless experience for both readers and contributors, fostering greater understanding of our products and their benefits.

The new IA design does the following:
Expand Down
3 changes: 2 additions & 1 deletion docs/source/migration/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "Migration to docs-builder"
navigation_title: Migration
---

# "Migration to docs-builder"

We are ready to migrate our documentation to our new build system, [elastic/docs-builder](https://github.com/elastic/docs-builder)!

:::{important}
Expand Down
3 changes: 2 additions & 1 deletion docs/source/migration/syntax.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: New syntax
navigation_title: New syntax
---

# New syntax

With the migration to Elastic Docs v3, the primary format for all Elastic Docs is transitioning from AsciiDoc to Markdown. Why Markdown? Markdown is already an industry standard across the industry, and 90% of Elastic developers are comfortable working with Markdown syntax [[source](https://docs.google.com/presentation/d/1morhFX4tyVB0A2f1_fnySzeJvPYf0kXGjVVYU_lVRys/edit#slide=id.g13b75c8f1f3_0_463)].

See our [syntax guide](../syntax/index.md) to learn more about the flavor of Markdown that we support.
Expand Down
4 changes: 1 addition & 3 deletions docs/source/migration/versioning.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Consolidated versioning
---
# Consolidated versioning

As part of the new information architecture, pages with varying versioning schemes are now interwoven, creating the opportunity and necessity to rethink the scope and versioning of each page. The previous approach of creating entirely separate docs sets for every minor version resulted in fragmentation and unnecessary duplication. Consolidating versioning resolves these issues while maintaining clarity and usability.

Expand Down
4 changes: 1 addition & 3 deletions docs/source/syntax/admonitions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Admonitions
---
# Admonitions

Admonitions allow you to highlight important information with varying levels of priority. In software documentation, these blocks are used to emphasize risks, provide helpful advice, or share relevant but non-critical details.

Expand Down
3 changes: 2 additions & 1 deletion docs/source/syntax/applies.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
title: Product Availability
applies:
stack: ga 8.1
serverless: tech-preview
Expand All @@ -8,6 +7,8 @@ applies:
ece: unavailable
---

# Product Availability


Using yaml frontmatter pages can explicitly indicate to each deployment targets availability and lifecycle status

Expand Down
4 changes: 1 addition & 3 deletions docs/source/syntax/automated_settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Automated settings reference
---
# Automated settings reference

Elastic Docs V3 supports the ability to build a markdown settings reference from a YAML source file.

Expand Down
4 changes: 1 addition & 3 deletions docs/source/syntax/code.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Code blocks
---
# Code blocks

Code blocks can be used to display multiple lines of code. They preserve formatting and provide syntax highlighting when possible.

Expand Down
4 changes: 1 addition & 3 deletions docs/source/syntax/conditionals.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Conditionals
---
# Conditionals

:::{warning}
This feature is not currently supported in Elastic Docs V3.
Expand Down
4 changes: 1 addition & 3 deletions docs/source/syntax/dropdowns.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Dropdowns
---
# Dropdowns

Dropdowns allow you to hide and reveal content on user interaction. By default, dropdowns are collapsed. This hides content until a user clicks the title of the collapsible block.

Expand Down
4 changes: 1 addition & 3 deletions docs/source/syntax/example_blocks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Example blocks
---
# Example blocks

:::{warning}
This feature is not currently supported in Elastic Docs V3.
Expand Down
5 changes: 1 addition & 4 deletions docs/source/syntax/file_inclusion.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
title: File inclusion
test: hi
---
# File inclusion

File inclusion is useful for
- including entire pages in a content set (usually done in the `docset.yml` file)
Expand Down
6 changes: 2 additions & 4 deletions docs/source/syntax/frontmatter.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Frontmatter
---
# Frontmatter

Each MD file referenced in the TOC requires frontmatter. Frontmatter is YAML-formatted metadata about a page, at the beginning of each file.
Each MD file referenced in the TOC may optionally define a frontmatter. Frontmatter is YAML-formatted metadata about a page, at the beginning of each file.

Supported frontmatter includes:

Expand Down
4 changes: 1 addition & 3 deletions docs/source/syntax/images.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Images
---
# Images

Images include screenshots, inline images, icons, and more. Syntax for images is like the syntax for links, with two differences:
1. instead of link text, you provide an image description
Expand Down
4 changes: 1 addition & 3 deletions docs/source/syntax/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Syntax guide
---
# Syntax guide

Elastic docs V3 supports markdown and various directives that add additional functionality to markdown.

Expand Down
4 changes: 1 addition & 3 deletions docs/source/syntax/links.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Links
---
# Links

A link contains link text (the visible text) and a link destination (the URI that is the link destination). The link text can include inline elements.

Expand Down
3 changes: 2 additions & 1 deletion docs/source/syntax/md-extensions.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Markdown Syntax Extensions
title_navigation: Markdown Syntax
---

# Markdown Syntax Extensions

## Syntax

The new documentation fully supports [CommonMark](https://commonmark.org/) Markdown syntax.
Expand Down
4 changes: 1 addition & 3 deletions docs/source/syntax/passthrough.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Passthrough blocks
---
# Passthrough blocks

:::{warning}
This feature is not currently supported in Elastic Docs V3.
Expand Down
4 changes: 1 addition & 3 deletions docs/source/syntax/sidebars.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Sidebars
---
# Sidebars

:::{warning}
This feature is not currently supported in Elastic Docs V3.
Expand Down
3 changes: 2 additions & 1 deletion docs/source/syntax/substitutions.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: Substitutions
sub:
frontmatter_key: "Front Matter Value"
a-key-with-dashes: "A key with dashes"
version: 7.17.0
---

# Substitutions

Substitutions can be defined in two places:

1. In the `frontmatter` YAML within a file.
Expand Down
Loading
Loading