search

w3c / wai-media-guide

11 stars 41 forks source link

Update submodule & change navigation.yml into symlink #178

Closed remibetin closed 3 years ago

remibetin commented 3 years ago

@shawna-slh @SteveALee I suggest updating the submodule and using a symlink for the navigation.yml file (as in other repositories) to get a correct navigation in the Netlify preview.

We can see the differences in the menu here :

netlify[bot] commented 3 years ago

:heavy_check_mark: Deploy Preview for wai-media-guide ready!

:hammer: Explore the source changes: bcd092adbf965b542521bdda941b5d68eceb6f8d

:mag: Inspect the deploy log: https://app.netlify.com/sites/wai-media-guide/deploys/60dc61fd6616fa00071e8775

:sunglasses: Browse the preview: https://deploy-preview-178--wai-media-guide.netlify.app

SteveALee commented 3 years ago

@remibetin CC @shawna-slh

Absolutely! Thanks.

The only reason this has not been done is there are a few resource repos in the same state and we have an action to look into why.

But, if as I suspect given your example previews, this is causing you a problem,we can easily merge your PR now.

There is a similar action to deal with submodule handling. FYI the submodules used for builds on netlfy or locally using "netlify build" are always the latest versions. The updated version is just not pushed to git for the resources. This is a workflow bug IMHO.

I can think of 3 possible explanations for having a local navigation.yml rather than using the latest shared version via the data submodule

@shawna-slh let me know if you'd like me to look at this issue for all repos some time soon. I'm happy to merge the PR.

remibetin commented 3 years ago

Thanks for your answer @SteveALee !

Indeed, I have no problem locally because I launch this command git submodule update --remote before serving Jekyll. I need this update in the repository only to facilitate reviews from other translators who will only look at the Netlify preview of my PR.

Actually the local navigation.yml file was part of the initial commit 098dbc8909b07cb8674c55023eee58a7a2059289

SteveALee commented 3 years ago

@remibetin

Indeed, I have no problem locally because I launch this command git submodule update --remote before serving Jekyll. I need this update in the repository only to facilitate reviews from other translators who will only look at the Netlify preview of my PR.

Perfect, and almost the same as the builds use

Actually the local navigation.yml file was part of the initial commit 098dbc8

Yeah. Yatil changed how things works several times as the site grew, so things vary between repos. I think the 3 possible reasons still apply though. Or do you have another?

SteveALee commented 3 years ago

@shawna-slh are you happy for this to be merged?

remibetin commented 3 years ago

Yeah. Yatil changed how things works several times as the site grew, so things vary between repos. I think the 3 possible reasons still apply though. Or do you have another?

No, I don't see another reason, and in the end, the shared version seems to be used in production.

shawna-slh commented 3 years ago

Thank you Rémi and Steve!

shawna-slh commented 3 years ago

I can think of 3 possible explanations for having a local navigation.yml rather than using the latest shared version via the data submodule

  • a simple bug
  • was used for local dev but accidentality committed
  • is supposed to diverge from the shared version - but this will soon get out of date.

@shawna-slh let me know if you'd like me to look at this issue for all repos some time soon.

Yes, please, Steve, thanks! I'm guessing either 1 or 2.