search

open-feature / docs.openfeature.dev

OpenFeature Documentation
https://openfeature.dev
Creative Commons Attribution 4.0 International
6 stars 19 forks source link

chore: update blog posts #307

Closed Arhell closed 1 year ago

Arhell commented 1 year ago

resolve https://github.com/open-feature/docs.openfeature.dev/issues/306

netlify[bot] commented 1 year ago

Deploy Preview for lucky-creponne-baf9b3 ready!

Name Link
Latest commit 76cda97560da3d701522d98097dd736d3bf1d9be
Latest deploy log https://app.netlify.com/sites/lucky-creponne-baf9b3/deploys/641884c16d6d630008377cde
Deploy Preview https://deploy-preview-307--lucky-creponne-baf9b3.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

aepfli commented 1 year ago

Thank you for this contribution, and I am sorry that my tooling integration is marking your checks as failing.

Interesting discussion topic: for mdx a comment has the structure of {/* ...*/}`, and therefore the tooling is complaining. Should we deactivate this check?

The second approach to tackle this is to rename the mdx files to md as they don't contain any mdx functionality. Generally, I would always recommend using md when no mdx functionality is needed. I know you're just trying to improve the blog and not the initial creator. But it is a nice catch.

Not sure what we should do. Maybe @beeme1mr can suggest how we process here :)

Arhell commented 1 year ago

Thanks for the description, I just suggest using the docusaurus functionality to the fullest, because as I see it, the blog should look like this, the description and the internal page are already a whole post. But if there is no need, I will close this PR

beeme1mr commented 1 year ago

Hey @Arhell, thanks for kicking this off! Only showing the intro on the main blog page is a great idea. I went ahead and moved all the blogs to .md files and slightly refactored them to look a bit nicer.

This will work for now, but it made me look into ways to improve the blog page even more. The best Docusaus blog page I've found is on Supabase but it's very custom. I love how they created a nice landing page, showing each blog as a tile. The blogs have nice improvements like a back button, related articles, share this article integration, and more. I would love to incorporate some of those elements into our blog.