You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
update 13-How-to-edit-wiki.md with first learnings from #142 #144
changed the title [-]update 13-How-to-edit-wiki.md with learnings from #142[/-][+]update 13-How-to-edit-wiki.md with first learnings from #142[/+]on Sep 11, 2023
Did you consider the "version change" scenario when the comment was made?
If yes, how would you explain the resulting omissions encountered from following them in #142 ?
I don't see correlation between broken links and different method of installing Node.js dependencies, and in your case, change installed in dependencies
Please note that current docs already mention when to "re-install" dependencies:
You'll need to run this command once when you first download the project, and again only if you package-lock.json file changes.
However, I was able to reproduce your no warning state, and it looks like a Docusaurus weird behavior (it shows warnings only on rebuilds) which is improved by #147
I can see that now we use both markdown links and regular links
Sorry, not sure which name above refers to which type of link :(
Therefore I refer to the problematic link type in combination with "numbered prefix" approach as "bad" link syntax.
Also I'm not really understanding what is meant by the second comment.
I'm looking for a working solution for everybody not have all your skills (aka user friendly).
Did we not come across this minor but annoying difference previously? I seem to remember so.
And actually I was surprised that only the previously existing link "/Advanced-Features/ETB/ETB-PID.md" required the number prefix, while all others did NOT.
Would it make sense to change the custom FOME link checker to throw an error on "bad" link syntax? or is that already implemented via #147?
Would it make sense to change the custom FOME link checker to throw an error on "bad" link syntax?
@karniv00l could you please comment on above question?
I'd be happy to change custom FOME link checker "scripts/linkValidator.js" to implement it if you agree.
Sure, I did a little refactor to make it more clear
Regarding .md links, it's actually a big upside that they are automatically validated by the build script, however a downside is that you need to provide a full file path (with numbered prefix), which will cause a refactor anytime someone move the order position. I didn't know about that feature
Activity
karniv00l commentedon Sep 11, 2023
That's an overstatement, current instructions look fine
[-]update 13-How-to-edit-wiki.md with learnings from #142[/-][+]update 13-How-to-edit-wiki.md with first learnings from #142[/+]mi-hol commentedon Sep 11, 2023
Did you consider the "version change" scenario when the comment was made?
If yes, how would you explain the resulting omissions encountered from following them in #142 ?
karniv00l commentedon Sep 11, 2023
I don't see correlation between broken links and different method of installing Node.js dependencies, and in your case, change installed in dependencies
Please note that current docs already mention when to "re-install" dependencies:
However, I was able to reproduce your no warning state, and it looks like a Docusaurus weird behavior (it shows warnings only on rebuilds) which is improved by #147
karniv00l commentedon Sep 11, 2023
Note that this will only check
markdownlinks while running dev server (npm start)will always fail when file does not exist:
it won't validate regular links
will only fail during the build when link does not work:
since they are not crawled before building (
npm run build)I can see that now we use both markdown links and regular links
mi-hol commentedon Sep 11, 2023
Sorry, not sure which name above refers to which type of link :(
Therefore I refer to the problematic link type in combination with "numbered prefix" approach as "bad" link syntax.
Also I'm not really understanding what is meant by the second comment.
I'm looking for a working solution for everybody not have all your skills (aka user friendly).
Did we not come across this minor but annoying difference previously? I seem to remember so.
And actually I was surprised that only the previously existing link "/Advanced-Features/ETB/ETB-PID.md" required the number prefix, while all others did NOT.
Would it make sense to change the custom FOME link checker to throw an error on "bad" link syntax? or is that already implemented via #147?
mi-hol commentedon Sep 11, 2023
is the preferred approach in combination with "numbered prefix", right?
mi-hol commentedon Sep 11, 2023
used above link syntax in #148 & #149
mi-hol commentedon Sep 11, 2023
@karniv00l could you please comment on above question?
I'd be happy to change custom FOME link checker "scripts/linkValidator.js" to implement it if you agree.
karniv00l commentedon Sep 11, 2023
Sure, I did a little refactor to make it more clear
Regarding
.mdlinks, it's actually a big upside that they are automatically validated by the build script, however a downside is that you need to provide a full file path (with numbered prefix), which will cause a refactor anytime someone move the order position. I didn't know about that featuremi-hol commentedon Sep 12, 2023
@karniv00l The suggested approach (validateRelativeUrls(files);) would from my view not have the best performance due to multiple reads of all files.
I've chosen to add all checks in the file read loop. (see https://github.com/mi-hol/fome-wiki/blob/validateLinks/scripts/linkValidator.js#L20)
Its not working yet but are you ok with this changed approach?
karniv00l commentedon Sep 12, 2023
sure