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/08 19:50:26 UTC
[GitHub] [hudi] bhasudha opened a new pull request, #6638: [DO NOT MERGE] [DOCS] Add tags to blog pages
bhasudha opened a new pull request, #6638:
URL: https://github.com/apache/hudi/pull/6638
### Change Logs
_Describe context and summary for this change. Highlight if any code was copied._
### Impact
_Describe any public API or user-facing feature change or any performance impact._
**Risk level: none | low | medium | high**
_Choose one. If medium or high, explain what verification was done to mitigate the risks._
### Contributor's checklist
- [ ] Read through [contributor's guide](https://hudi.apache.org/contribute/how-to-contribute)
- [ ] Change Logs and Impact were stated clearly
- [ ] Adequate tests were added if applicable
- [ ] CI passed
--
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
[GitHub] [hudi] nsivabalan commented on a diff in pull request #6638: [DOCS] Add tags to blog pages
Posted by GitBox <gi...@apache.org>.
nsivabalan commented on code in PR #6638:
URL: https://github.com/apache/hudi/pull/6638#discussion_r976869703
##########
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:
guess we might need to add blog as one of the value.
--
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
[GitHub] [hudi] bhasudha commented on a diff in pull request #6638: [DOCS] Add tags to blog pages
Posted by GitBox <gi...@apache.org>.
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
[GitHub] [hudi] bhasudha commented on pull request #6638: [DO NOT MERGE] [DOCS] Add tags to blog pages
Posted by GitBox <gi...@apache.org>.
bhasudha commented on PR #6638:
URL: https://github.com/apache/hudi/pull/6638#issuecomment-1250195788
> Can you share some screenshots here.
>
> IMO main things to have as tags.
>
> **tag1**
>
> * how-to (tutorial, recipes, show case how to use feature x)
> * case-study. (some company talking about their use-case)
> * deep-dive (technical articles talking about Hudi internal design/impl)
> * architecture (broader ones talking about data architectures etc)
>
> **tag 2** you can then tag individual features - clustering, compaction, etc.
>
> **tag 3** you can then add the use-case - ingestion, etl, .. (or skip if it applies in general)
>
> Please add a section like this to README and we then land this, this way we can review all future entries for accuracy/ to be inline with this
Done. Please take a look.
The site would look like this with tags.
<img width="1415" alt="Screen Shot 2022-09-17 at 9 51 12 PM" src="https://user-images.githubusercontent.com/2179254/190887259-4d132474-0763-48c2-ba03-7413242588fb.png">
<img width="1440" alt="Screen Shot 2022-09-17 at 9 51 37 PM" src="https://user-images.githubusercontent.com/2179254/190887263-ea1b6818-2bda-4fe6-9b53-7ddd7915168d.png">
<img width="1439" alt="Screen Shot 2022-09-17 at 9 51 55 PM" src="https://user-images.githubusercontent.com/2179254/190887265-35aaf835-aba4-4003-a337-e10f72b02511.png">
<img width="1475" alt="Screen Shot 2022-09-17 at 9 52 09 PM" src="https://user-images.githubusercontent.com/2179254/190887266-c89566c3-653f-4e1e-b656-1ec1953e0795.png">
<img width="1479" alt="Screen Shot 2022-09-17 at 9 52 21 PM" src="https://user-images.githubusercontent.com/2179254/190887267-7936a983-2aa9-48ac-a8b0-0083ac2cf973.png">
--
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
[GitHub] [hudi] nsivabalan merged pull request #6638: [DOCS] Add tags to blog pages
Posted by GitBox <gi...@apache.org>.
nsivabalan merged PR #6638:
URL: https://github.com/apache/hudi/pull/6638
--
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