You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hudi.apache.org by GitBox <gi...@apache.org> on 2022/09/21 22:20:55 UTC

[GitHub] [hudi] bhasudha commented on a diff in pull request #6638: [DOCS] Add tags to blog pages

bhasudha commented on code in PR #6638:
URL: https://github.com/apache/hudi/pull/6638#discussion_r977030742


##########
README.md:
##########
@@ -156,6 +156,44 @@ Example: When you change any file in `versioned_docs/version-0.7.0/`, it will on
 ## Configs
 Configs can be automatically updated by following these steps documented at ../hudi-utils/README.md
 
+## Blogs
+
+When adding a new blog, please follow these guidelines.
+
+1. Every Blog should have the `title`, `authors`, `image`, `tags` in the metadata of the blog. For example the front matter 
+for a blog should look like below. 
+```
+---
+title: "Blog title"
+author: FirstName LastName
+category: blog
+image: /assets/images/blog/<image_file>
+tags:
+- how-to
+- deltastreamer
+- incremental-processing
+- apache hudi
+---
+```
+2. The blog can be inline or referring to an external blog. If its an inline blog please save it as `.md` file. 
+Example for an inline blog - (Build Open Lakehouse using Apache Hudi & dbt)[https://github.com/apache/hudi/blob/asf-site/website/blog/2022-07-11-build-open-lakehouse-using-apache-hudi-and-dbt.md]. 
+If the blog is referring to an external blog you would need to embed the redirect url and save it as a `.mdx` file. 
+Take a look at this blog for reference - (Apache Hudi vs Delta Lake vs Apache Iceberg - Lakehouse Feature Compariso)[https://raw.githubusercontent.com/apache/hudi/asf-site/website/blog/2022-08-18-Apache-Hudi-vs-Delta-Lake-vs-Apache-Iceberg-Lakehouse-Feature-Comparison.mdx]
+3. The image must be uploaded in the path /assets/images/blog/<image_file-name> and should be of standard size 1200 * 600
+4. The tags should be representative of these
+   1. tag1
+      - how-to (tutorial, recipes, show case how to use feature x)

Review Comment:
   ah yes. I ll add  it in a followup pr



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@hudi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org