search

yuzutech / blog.yuzutech.fr

Code, content and configuration for blog.yuzutech.fr
https://blog.yuzutech.fr
6 stars 6 forks source link

Sort components post initial draft #16

Closed djencks closed 3 years ago

djencks commented 3 years ago

Initial draft of a proposed guest post on how to sort Antora components and versions in the UI. I didn't look for an appropriate image. I suggest some package.json changes to add useful scripts. The site build doesn't work well for me, perhaps because I don't have the font awesome pro icons.

ggrossetie commented 3 years ago

Thanks @djencks I will take a look this week.

Could you please move code snippets (hbs and js) to the (https://github.com/yuzutech/blog.yuzutech.fr/tree/master/blog/modules/ROOT/examples)[examples] directory (you can create a dedicated subdirectory examples/antora-sort)?

You will also need to revert 20e6e63 (#16). I wish upgrading Antora was as easy as bumping the version in the package.json but since I'm overriding some packages it's not that simple (I need to do some shenanigans in the package-lock.json).

The site build doesn't work well for me, perhaps because I don't have the font awesome pro icons.

FontAwesome pro integration is a PITA and it now requires a 99$/year subscription to use the npm private package registry so I will probably move away. Having said that, it should work even if you dont have FontAwesome pro icons because the dependencies are optional. Do you have an error when installing locally? (it won't work on Netlify since you don't have access to my secret token but on your machine it should work).

You can try to remove https://github.com/yuzutech/blog.yuzutech.fr/blob/master/.npmrc

djencks commented 3 years ago

Done, looking forward to your review.

The problems were illusory, and caused by my forgetting that indexify doesn't work well on a plain filesystem.

I didn't see any problems with my antora 2.3.4 build, but maybe I didn't look hard enough.

The more useful part of the package.json change is the scripts, which I find quite useful:

  "scripts": {
    "clean-install": "rm -rf node_modules package-lock.json .cache;npm i --cache=.cache/npm",
    "build": "./node_modules/.bin/antora site.yml --html-url-extension-style=indexify --generator ./lib/generator.js"
  },

YMMV of course.

ggrossetie commented 3 years ago

I will try to take care of the FontAwesome pro issue Thursday so we can have a deploy preview. And I will probably review the content at the same time 😄

For the illustration, I can suggest:

djencks commented 3 years ago

Thanks for the image pointers. I found one that appears to show people designing the order of the component explorer :-)

On Sep 29, 2020, at 10:29 AM, Guillaume Grossetie notifications@github.com wrote:

I will try to take care of the FontAwesome pro issue Thursday so we can have a deploy preview. And I will probably review the content at the same time 😄

For the illustration, I can suggest:

https://unsplash.com/photos/fi3_lDi3qPE https://unsplash.com/photos/fi3_lDi3qPE https://unsplash.com/photos/L06-OsgvNoM https://unsplash.com/photos/L06-OsgvNoM — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/yuzutech/blog.yuzutech.fr/pull/16#issuecomment-700865584, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAELDXSXCA32BJLNYGUC3RDSIIKRJANCNFSM4R3DTZ4Q.

ggrossetie commented 3 years ago

@djencks Could you please rebase on master? I've removed the FontAwesome pro dependency, it should fix the deployment.

djencks commented 3 years ago

Done, and the callout number now is rendered!

On Oct 1, 2020, at 11:39 AM, Guillaume Grossetie notifications@github.com wrote:

@djencks https://github.com/djencks Could you please rebase on master? I've removed the FontAwesome pro dependency, it should fix the deployment.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/yuzutech/blog.yuzutech.fr/pull/16#issuecomment-702324457, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAELDXXRNW5UGDADTNYH3VTSITEHPANCNFSM4R3DTZ4Q.

ggrossetie commented 3 years ago

Excellent! I will enable syntax highlighting for Handlebars (to make it easier to read).

djencks commented 3 years ago

Thanks for the really nice detailed review! I believe I took all your suggestions except for a couple of modifications I noted in comments.

ggrossetie commented 3 years ago

Perfect, I replied to your comment. Once we agreed on the two last suggestions we can proceed.