docs(medcat): Move away from v2 prefix - #607
Open
mart-r wants to merge 56 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR moves away from
medcat-v2prefix to justmedcat.While the change itself is not super massive, it will touch a lot of files that had links or other references to the v2 path.
The most immediate changes are:
medcat-v2folder renamed tomedcatmedcat-v2-tutorialsfolder renamed tomedcat-v2-tutorialsBut there's a lot of things in many different parts (especially with local install / test against core lib state) that also needed changed.
PS:
This PR will trigger almost all the workflows (didn't check, but just a guess - it targets most of the larger ones at least). So I wouldn't be surprised if something is broken somewhere. Especially if it hits stuff that we've not touched in a while.
EDIT:
The docs build initially failed since the config on their side says to explicitly look for
medcat-v2/readthedocs.yamland that can no longer be found. But I did change it (tempoarily) to the newmedcat/readthedocs.yaml. If/when this PR gets merged, the change would need to be made permanent.In any case, here's the link to the docs:
https://cogstack-platform-toolkit--607.org.readthedocs.build/projects/nlp/en/607/
EDIT2:
For some reason a bunch of the links in the docs are not working.Not entirely sure why that is.
As far as I can tell, I've done everything in the same way that it was done in the previous
medcat[-v2]/mkdocs.yaml.But I'm sure I just missed something obvious.
EDIT3:
I've since resolved the above issue. Turned out the conversion I had done was all good. But the issue was in how some plugin was handling the folder name of
medcat/medcat(previouslymedcat-v2/medcat). Because of both folders having the same name, some plugins didn't work as expected.So the fix was to add a hook to fix the links.
The reason these needed to be fixed in the first place is because they're in the
README.mdwhich is pulled intodocs/index.md. However, the links are relative to themedcatfolder rather than themedcat/docsfolder. Previously this was correctly fixed automatically, but now it was not due to the confusion with the folder names.The other caveat is that the hook had to change
README.mdduringindex.mdread since the inclusion of it withinindex.mdhappens by another plugin at a later stage.