Skip to content

[DOCS] blog setup #1925

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

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

[DOCS] blog setup #1925

wants to merge 13 commits into from

Conversation

kadolor
Copy link
Contributor

@kadolor kadolor commented Apr 23, 2025

Did you read the Contributor Guide?

Is this PR related to a ticket?

  • No:
    • this is a documentation update. The PR name follows the format [DOCS] my subject

What changes were proposed in this PR?

How was this patch tested?

Did this PR include necessary documentation updates?

NA

@kadolor kadolor requested a review from jiayuasu as a code owner April 23, 2025 23:17
@kadolor kadolor marked this pull request as draft April 23, 2025 23:24
@kadolor kadolor requested a review from jiayuasu April 24, 2025 00:20
@kadolor kadolor marked this pull request as ready for review April 30, 2025 07:58
@jiayuasu jiayuasu requested a review from Copilot April 30, 2025 19:58
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a new blog section to the documentation by updating navigation, adding blog plugin configurations in mkdocs.yml, and creating the blog landing page along with an authors file.

  • Adds a "Blog" entry to the site navigation and configures the blog plugin in mkdocs.yml.
  • Introduces a new blog index page with introductory content in docs/blog/index.md.
  • Provides an authors configuration file in docs/blog/.authors.yml to list blog authors.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

File Description
mkdocs.yml Adds a new "Blog" navigation entry and blog plugin configurations.
docs/blog/index.md Creates a new blog index page with introductory content.
docs/blog/.authors.yml Introduces an authors listing for the blog.

@kadolor kadolor requested a review from jbampton as a code owner May 6, 2025 01:12
@kadolor
Copy link
Contributor Author

kadolor commented May 6, 2025

@jiayuasu Updated the insert-license hook in .pre-commit-config.yaml to also exclude Markdown files under docs/blog/posts/. This prevents the license header from conflicting with the YAML front matter required by MkDocs at the top of blog posts.

@jiayuasu
Copy link
Member

jiayuasu commented May 6, 2025

@kadolor The PR LGTM. Let me know when it is ready to be merged

Copy link
Member

@jbampton jbampton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pre-commit changes look fine.

Thanks !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants