Skip to content

update 13-How-to-edit-wiki.md with first learnings from #142 #144

Open

Description

@mi-hol

Current instructions for https://wiki.fome.tech/How-to-edit-wiki/#how-to-test-your-changes are incomplete/wrong
See #142 (comment) for details

Activity

  1. karniv00l commented on Sep 11, 2023

    @karniv00l
    Member

    That's an overstatement, current instructions look fine

  2. 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
  3. mi-hol commented on Sep 11, 2023

    @mi-hol
    ContributorAuthor

    current instructions look fine

    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 ?

  4. karniv00l commented on Sep 11, 2023

    @karniv00l
    Member

    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

  5. karniv00l commented on Sep 11, 2023

    @karniv00l
    Member

    Note that this will only check markdown links while running dev server (npm start)

    will always fail when file does not exist:

    [ETB PID and Autotune](/07-Advanced-Features/ETB/ETB-PID.md) 

    it won't validate regular links

    will only fail during the build when link does not work:

    [ETB PID and Autotune](/Advanced-Features/ETB/ETB-PID)

    since they are not crawled before building (npm run build)

    I can see that now we use both markdown links and regular links

  6. mi-hol commented on Sep 11, 2023

    @mi-hol
    ContributorAuthor

    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?

  7. mi-hol commented on Sep 11, 2023

    @mi-hol
    ContributorAuthor

    will only fail during the build when link does not work:

    [ETB PID and Autotune](/Advanced-Features/ETB/ETB-PID)
    

    is the preferred approach in combination with "numbered prefix", right?

  8. mi-hol commented on Sep 11, 2023

    @mi-hol
    ContributorAuthor

    used above link syntax in #148 & #149

  9. mi-hol commented on Sep 11, 2023

    @mi-hol
    ContributorAuthor

    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.

  10. karniv00l commented on Sep 11, 2023

    @karniv00l
    Member

    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

  11. mi-hol commented on Sep 12, 2023

    @mi-hol
    ContributorAuthor

    Sure, I did a little refactor to make it more clear

    @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?

  12. karniv00l commented on Sep 12, 2023

    @karniv00l
    Member

    sure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions