This is an automated email from the ASF dual-hosted git repository.
xushiyan pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/hudi.git
The following commit(s) were added to refs/heads/asf-site by this push:
new c4ec924ca6ba chore(site): update agents instruction (#14323)
c4ec924ca6ba is described below
commit c4ec924ca6ba4ecbf24c37ed8a6035fe12fc69d1
Author: Shiyan Xu <[email protected]>
AuthorDate: Sun Nov 23 01:51:02 2025 -0600
chore(site): update agents instruction (#14323)
* chore: update `AGENTS.md`
* remove redundant file
---
AGENTS.md | 26 ++++++++++++++++++--------
website/docs/intro.md | 47 -----------------------------------------------
2 files changed, 18 insertions(+), 55 deletions(-)
diff --git a/AGENTS.md b/AGENTS.md
index e8f261a1dbe9..e8d5285fcafb 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -1,21 +1,25 @@
-# How to Add a New Blog Post
+# Agents Instructions
-This repo hosts the Docusaurus website for Hudi. To add a new blog post:
+This repo hosts the Docusaurus website for Hudi.
-## 1. Blog Markdown File
+## Adding a New Blog Post
+
+To add a new blog post:
+
+### Blog Markdown File
- Place in: `website/blog/`
- Name: `YYYY-MM-DD-<slug>.md` (date + slug from title)
- Slug: lowercase, hyphens for spaces/underscores, only
letters/numbers/hyphens
- Example: `2025-11-03-introducing-streaming-compaction-v2.md`
-## 2. Images Folder
+### Images Folder
- Place images in: `website/static/assets/images/blog/<filename-without-md>/`
- Reference images in markdown as:
- ``
-## 3. Front Matter Example
+### Front Matter Example
```yaml
---
@@ -29,13 +33,13 @@ tags:
---
```
-## 4. Content Tips
+### Content Tips
- Keep paragraphs short.
- Use descriptive alt text for images.
- Add a `description` for SEO.
-## 5. Example Directory Layout
+### Example Directory Layout
```text
website/
@@ -50,9 +54,15 @@ website/
└─ diagram.png
```
-## 6. Commit
+### Commit
- Only change files under `website/`.
- Commit message: `docs(blog): add YYYY-MM-DD-<slug>`
Your post is now ready for review.
+
+## Updating Documentation Pages
+
+The `website/docs` directory contains documentation pages for the Hudi
project, which are versioned against releases.
+
+When updating a markdown file in the hudi website repo, if the file contains a
`last_modified_at` field in its front matter, update it to the current date
when modifying the file.
diff --git a/website/docs/intro.md b/website/docs/intro.md
deleted file mode 100644
index 45e8604c8bf8..000000000000
--- a/website/docs/intro.md
+++ /dev/null
@@ -1,47 +0,0 @@
----
-sidebar_position: 1
----
-
-# Tutorial Intro
-
-Let's discover **Docusaurus in less than 5 minutes**.
-
-## Getting Started
-
-Get started by **creating a new site**.
-
-Or **try Docusaurus immediately** with
**[docusaurus.new](https://docusaurus.new)**.
-
-### What you'll need
-
-- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
- - When installing Node.js, you are recommended to check all checkboxes
related to dependencies.
-
-## Generate a new site
-
-Generate a new Docusaurus site using the **classic template**.
-
-The classic template will automatically be added to your project after you run
the command:
-
-```bash
-npm init docusaurus@latest my-website classic
-```
-
-You can type this command into Command Prompt, Powershell, Terminal, or any
other integrated terminal of your code editor.
-
-The command also installs all necessary dependencies you need to run
Docusaurus.
-
-## Start your site
-
-Run the development server:
-
-```bash
-cd my-website
-npm run start
-```
-
-The `cd` command changes the directory you're working with. In order to work
with your newly created Docusaurus site, you'll need to navigate the terminal
there.
-
-The `npm run start` command builds your website locally and serves it through
a development server, ready for you to view at http://localhost:3000/.
-
-Open `docs/intro.md` (this page) and edit some lines: the site **reloads
automatically** and displays your changes.
