Is it still alive? (Problems with usage)
azinit opened this issue · 14 comments
Hello!
I have some issues with usage of package, is it still alive for usage?
(its great, that you implemented the idea of WYSIWYG editing, but it would be pity if it doesn't work now)
Problem 1: Live Preview
There is the link to Live Preview At the top of README
I follow steps on playground, but can't reach some visible result 🤔
(What am I doing wrong? Or it's trouble with package/demo?)
Looks like that I have problem with url of article, or may be some required credentials (but should it required for "get started live preview? 🤔")
ZWxFRZAS5t.mp4
Problem 2: Setup
Next, I've tried to setup package locally for my docusaurus project (with special clientId from OAuthApp and with special authToken which was received by gatekeeper)
But again - there is problem with usage of package
It would be great to add more details for setuping, especially for users, who doesn't have a lot of experience with OAuthApps and Github credentials
Config
Docusaurus.config.js
Dependencies
Also, at first it was installed as "@jlvandenhout/docusaurus-plugin-docs-editor": "jlvandenhout/docusaurus-plugin-docs-editor" and it need to specify version
P.S.
Thank for your efforts, still hope that package is ready for usage!
Thank you for checking this out! Unfortunately I got a bit sidetracked by other projects the last few months and lacked the person-hours to maintain this. The intention is there to bring it back to life though, as this was build as a first try to improve contributions to the IOTA Wiki and we are still looking into this in the background.
It might be though that we restructure this project. Currently it is completely client side, including the HTML-Markdown transpiling and GitHub integration, which makes it really difficult to make this a generalized Docusaurus plugin. That's why I'm looking into move to a server side solution, to skip transpile steps, remove the need of fork management for the user, allow multiple login providers, etc.
All in all the next version should address your issues. I will work on this the next couple of weeks.
Thank you for the prompt response!
I really understand you in terms of the lack of person-hours
Proposal
Also, I realized that there are plans for full-fledged refactoring, but as far as I understand, it somehow lives in the IOTA Wiki already now
|
|
|
In other words, it looks like the solution is ready to work, even with rough edges. Is it possible in this case to take into plans the correction of critical bugs (the demo still does not work) and a describe of a more detailed GetStarted steps?
With best regards
I show such interest and perseverance, because our project really needed a similar solution, and it is extremely expensive to implement from scratch.
If it turned out to integrate even at the same level as in the IOTA Wiki, we could sometimes bring contributions to this repository, I suppose 🤔
Anyway, I don't want to seem impudent, I just really liked the idea of the project and would like to integrate this into our project as soon as possible
Thank you again for your efforts!
In other words, it looks like the solution is ready to work, even with rough edges. Is it possible in this case to take into plans the correction of critical bugs (the demo still does not work) and a describe of a more detailed GetStarted steps?
@jlvandenhout What do you think about it? 😏
Looks like "fix critical bugs & describe GetStarted more detailed" will be less expensive, than refactor implementation totally 🤔
@jlvandenhout Sorry for annoying =)
Could please at least specify some details about Problem 2: Setup from description? How could I resolve it?
I wish to setup this plugin anyway at my project (our team really need it), but this problem is blocking for me 🤷♂️
Ah, that issue is not related to your OAuth setup, it is a breaking change between docusaurus versions. Let me see if I can fix that tonight.
it is a breaking change between docusaurus versions
Oh that's exactly what I was afraid of...
Let me see if I can fix that tonight.
Thanks! You'll be my hero 😄
Thank you for checking this out! Unfortunately I got a bit sidetracked by other projects the last few months and lacked the person-hours to maintain this. The intention is there to bring it back to life though, as this was build as a first try to improve contributions to the IOTA Wiki and we are still looking into this in the background.
It might be though that we restructure this project. Currently it is completely client side, including the HTML-Markdown transpiling and GitHub integration, which makes it really difficult to make this a generalized Docusaurus plugin. That's why I'm looking into move to a server side solution, to skip transpile steps, remove the need of fork management for the user, allow multiple login providers, etc.
All in all the next version should address your issues. I will work on this the next couple of weeks.
This raises some interesting discussion points that may warrant a larger quorum and a separate conversation, but I'm curious about the following:
- Could developers have the choice between client- and server-side?
- Users that deploy their docusaurus page as a static site won't be able to run this if it's server-side (unless they explicitly host a service and configure endpoints, etc.)
- WRT to fork management, could users provide their own editor in the future where the input and output are just the strings of the markdown content?
- I'd be particularly interested in leveraging TUI Editor as proposed in this Docusaurus feature proposal
it is a breaking change between docusaurus versions
Oh that's exactly what I was afraid of...
Let me see if I can fix that tonight.
Thanks! You'll be my hero 😄
To come back to this, Docusaurus beta 15 release moved hooks that this plugin is using to a separate location. So you have to update to beta 15 release or higher for this plugin to work, I added it as a peer dependency to indicate this.
To come back to this, Docusaurus beta 15 release moved hooks that this plugin is using to a separate location. So you have to update to beta 15 release or higher for this plugin to work, I added it as a peer dependency to indicate this.
Ok, I get it
We'll try to update to new version, thanks!
@azinit In the mean time I have refactored the package, rewrote the README with a more clear guide how to test locally and updated some of the url resolving logic. While Docusaurus beta 16 results in a few cosmetic issues in the preview, the editor is functional and I released it as package version 0.8.0. Could you provide feedback?
@francis-robert These are valid questions, and I think both should be possible, but require a major modularization of the package. I have to do this anyway to allow a server backend, so let me get back to this later.
@jlvandenhout Hello!
Sorry for too long response - current terrible world events have knocked out of life :(
I'll try to setup WYSIWYG in the coming days and will provide feedback you ASAP
Thank you for your support and project!
No problem at all! Take your time, I'm in no hurry.
Hello,
I have just read through this. Are you still working on this?
thx
stefan
As indicated in the other issue, no, it is currently a dead project due to not enough resources and no real current use-case in our project.