Skip to content

Feature: Add a blogs page to the OPEA io docs site #309

New issue

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

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

Already on GitHub? # to your account

Closed
mkbhanda opened this issue Feb 28, 2025 · 12 comments
Closed

Feature: Add a blogs page to the OPEA io docs site #309

mkbhanda opened this issue Feb 28, 2025 · 12 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed OPEAHack Issue created for OPEA Hackathon v1.3

Comments

@mkbhanda
Copy link
Collaborator

We have a collection of OPEA blogs spanning how to create a custom ChatQnA application, use a DeekSeek model, achieve multi-model input QnA. It would be nice to list them on the OPEA io docs web site, serving links to these articles. In so doing it adds another way to find these blogs, keeping things all together.
We need to define a location in the docs repo to submit PRs to accept new blog links and automated tooling to publish these to the OPEA io docs site.

@mkbhanda mkbhanda added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed OPEAHack Issue created for OPEA Hackathon v1.3 labels Feb 28, 2025
@pranavgupta1112
Copy link
Contributor

Hi @mkbhanda ,
can you elaborate on this,
Creating a separate blogs section is understandable, Do you also intend to scrape the content automatically and publish here

@cvsathis
Copy link

cvsathis commented Mar 3, 2025

OPEA_TEAM1 Currently working on this issue

@mkbhanda
Copy link
Collaborator Author

mkbhanda commented Mar 4, 2025

No scraping required. Let blog authors submit a PR by editing blogs.md.
The advantage of the PR is we can review the blog and ensure it is OPEA related versus scraping .. where AI could play a role to check if it was our OPEA project or other, but it would also need to take care of removing duplicates .. does that not feel like web crawling .. too much overhead!

The file itself should contain a table with entries in reverse chronological order. I was thinking of something like below.


OPEA Blogs

Come learn, try, develop, and share your stories!
Please submit PRs, organizing content in reverse chronological order.

:Date : URL : Authors

|02/26/2025|https://www.intel.com/content/www/us/en/developer/articles/technical/multimodal-q-and-a-step-by-step-guide.html|Melanie Hart Buehler, Mustafa Cetin, Dina Suehiro Jones|
|02/12/2025|https://www.intel.com/content/www/us/en/developer/articles/guide/deploy-a-deepseek-r1-distill-chatbot-on-aws-xeon.html|Alex Sin|
|01/24/2025|https://opea.dev/news/|OPEA Team
|10/14/2024|https://vmblog.com/archive/2024/10/14/harness-enterprise-genai-using-opea.aspx|Iris Ding, Malini Bhandaru

@mkbhanda
Copy link
Collaborator Author

mkbhanda commented Mar 4, 2025

You will have to research how to publish, you should be able to build and publish in your development setup https://github.com/opea-project/docs/blob/main/scripts/publish-README.md

Plus will need to add a link to the blogs file (follow best practice -- relative file or absolute path?)
in some navigation pane too. Perhaps grep for a file like CONTRIBUTING.md and see where all it pops up.
See

contribute to the project in this :doc:`Contribution Guide <CONTRIBUTING>`.

@yinghu5
Copy link
Collaborator

yinghu5 commented Mar 4, 2025

@mkbhanda and Jianyu,
Thank jianyu quick response and create the PR add chapter Publications #314, please help to review,
thank you!

@pranavgupta1112
Copy link
Contributor

Hi @yinghu5 , We've already completed adding the basic blog page,
But it seems @mkbhanda had a broader vision, so we were waiting for her feedback and ideas.

Also we've already marked that OPEA_Team1 is working on this.

@mkbhanda
Copy link
Collaborator Author

mkbhanda commented Mar 5, 2025

I so appreciate two teams jumping on this issue but I am SAD that @NeoZhangJianyu either did not see that the issue was assigned to @pranavgupta1112 and team or if he took on the work earlier then not assigning it to himself. This avoids situations like this of duplicated work.

@ashahba
Copy link
Collaborator

ashahba commented Mar 5, 2025

I so appreciate two teams jumping on this issue but I am SAD that @NeoZhangJianyu either did not see that the issue was assigned to @pranavgupta1112 and team or if he took on the work earlier then not assigning it to himself. This avoids situations like this of duplicated work.

Agreed.
Hopefully this is an honest mistake and we won't run into it anytime soon.

@pranavgupta1112
Copy link
Contributor

@yinghu5 , We had a discussion with @mkbhanda , she had few suggestions,
We can complete those fixes together and close the issue post that.

@pranavgupta1112
Copy link
Contributor

Blogs Page Added

#318

Image

@yinghu5
Copy link
Collaborator

yinghu5 commented Mar 26, 2025

@mkbhanda @pranavgupta1112 thank you a lot for the contribution!

@yinghu5 yinghu5 closed this as completed Mar 26, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed OPEAHack Issue created for OPEA Hackathon v1.3
Projects
None yet
Development

No branches or pull requests

5 participants