upgrading Docusaurus to v3 #374
Conversation
Signed-off-by: Aditya-eddy <aditya282003@gmail.com>
Signed-off-by: Aditya-eddy <aditya282003@gmail.com>
Signed-off-by: Aditya-eddy <aditya282003@gmail.com>
|
Hey @Aditya-eddy ,Please mention the issue number for discussion. @Sonichigo Please review. |
|
Hey @re-Tick I just created the pr and pushed it. Have not created an issue for it should I? |
Signed-off-by: Aditya-eddy <aditya282003@gmail.com>
Signed-off-by: Aditya-eddy <aditya282003@gmail.com>
It will be good to mention the issue. |
Signed-off-by: Aditya-eddy <aditya282003@gmail.com>
| @@ -1,40 +0,0 @@ | |||
| /** | |||
There was a problem hiding this comment.
Hey @Aditya-eddy what's the reason behind removing these files are they not getting used now ?
There was a problem hiding this comment.
Also can you please check this warning
(node:187143) [DEP_WEBPACK_COMPILATION_ASSETS] DeprecationWarning: Compilation.assets will be frozen in future, all modifications are deprecated.
BREAKING CHANGE: No more changes should happen to Compilation.assets after sealing the Compilation.
Do changes to assets earlier, e. g. in Compilation.hooks.processAssets.
Make sure to select an appropriate stage from Compilation.PROCESS_ASSETS_STAGE_*.
(Use node --trace-deprecation ... to show where the warning was created)
client (webpack 5.88.2) compiled successfully
There was a problem hiding this comment.
Hey @Hermione2408 about the deleted files I think they were used for blogs section. But I don't think there is any blog section in website. Let me look into the error!
|
Hey @Aditya-eddy, there is an error while starting with 
With last commit as well the deploy check is failing :- https://github.com/keploy/docs/actions/runs/8749516911/job/24011321177?pr=374 |
Signed-off-by: Aditya-eddy <aditya282003@gmail.com>
Hey @Sonichigo actually the docusaurus uses nodejs>=18, but in the github workflow file it was downloading the 16 some version. I have corrected the version to 18.0.0 nodejs. I think the workflow went smoothly this time. But please do check and give feedback on it. Thanks!! |
Signed-off-by: Aditya-eddy <aditya282003@gmail.com>
There was a problem hiding this comment.
@Aditya-eddy there are certain warning that needs to be fixed before final merge
|
Hey @Sonichigo I have resolved all the errors only the pet-clinic error is remaining because in there we have used h1 anchors manually whiich docusaurus does not allow hence shows. Broken-Links Reference here. |
There was a problem hiding this comment.
In http://localhost:3000/docs/quickstart/pet-clinic/ there are two brokenAnchors warning! You can use below to update and fix those.
# Instructions For Starting Using Binary <a name="binary-guide"></a>
to
## Instructions For Starting Using Binary.
and
# Instructions For Starting Using Docker <a name="docker-guide"></a>
to
## Instructions For Starting Using Docker
Signed-off-by: Aditya-eddy <aditya282003@gmail.com>
|
Hey @Sonichigo I have pushed the updated changes! |
There was a problem hiding this comment.
@Aditya-eddy this is great! Just that we can't make h1 tags h2. We need to find a workaround to maintain h1 tags.
Instead of using anchors we can directly link endpoints for H1 in case anchors are not supported for H1s.
Signed-off-by: Aditya-eddy <aditya282003@gmail.com>
|
Hey @nehagup i have swizzled heading component and made the h1 tags have anchors too. By default they will have id as heading but we can set them explicitly by #heading {#id}. Please give feedback on this. |
* upgrading to v3 Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * correcting the mdx Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * removing remark plugins Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * correcting some files Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * adding the commented code Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * removing the plugin Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * trying nodejs version 18 Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * errors Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * resolving anchors Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * swizzling the heading component Signed-off-by: Aditya-eddy <aditya282003@gmail.com> --------- Signed-off-by: Aditya-eddy <aditya282003@gmail.com> Co-authored-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com> Co-authored-by: Neha Gupta <gneha21@yahoo.in>
* upgrading to v3 Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * correcting the mdx Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * removing remark plugins Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * correcting some files Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * adding the commented code Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * removing the plugin Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * trying nodejs version 18 Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * errors Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * resolving anchors Signed-off-by: Aditya-eddy <aditya282003@gmail.com> * swizzling the heading component Signed-off-by: Aditya-eddy <aditya282003@gmail.com> --------- Signed-off-by: Aditya-eddy <aditya282003@gmail.com> Co-authored-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com> Co-authored-by: Neha Gupta <gneha21@yahoo.in>
Pull Request Template
Description
fixes #1833
We should upgrade to v3 so that we increase the browsers support.
Fixes # (issue)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Additional Context (Please include any Screenshots/gifs if relevant)
...
Checklist: