Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: migrate netlify-cms-widget-starter to the official docs #4129

Open
erezrokah opened this issue Aug 9, 2020 · 7 comments
Open

Docs: migrate netlify-cms-widget-starter to the official docs #4129

erezrokah opened this issue Aug 9, 2020 · 7 comments

Comments

@erezrokah
Copy link
Collaborator

@erezrokah erezrokah commented Aug 9, 2020

There are two ways to build a custom widget:

  1. Using vanilla JS as described in the docs: https://www.netlifycms.org/docs/custom-widgets/#registerwidget
  2. Using JSX syntax with a build step which is covered in https://github.com/netlify/netlify-cms-widget-starter

We should migrate the latter option to the docs.

@KancerEzeroglu
Copy link

@KancerEzeroglu KancerEzeroglu commented Aug 12, 2020

Hi @erezrokah ,
I have checked the document that you shared as a first option. I saw someone has already added a link for the second way (you can check the screenshot). I think it is not enough for you, right? Could you elaborate more on the issue?
If it is possible, I can take this issue.
Screen Shot 2020-08-12 at 14 27 50

@erezrokah
Copy link
Collaborator Author

@erezrokah erezrokah commented Aug 12, 2020

Thanks @KancerEzeroglu, sorry for not being clear with the issue.
We should re-write the repo https://github.com/netlify/netlify-cms-widget-starter as a step by step guide and add it to the docs.
The guide will replace the current forking workflow that is required to create the widget.
One example for a step by step guide is https://www.netlifycms.org/docs/gatsby/.

@KancerEzeroglu
Copy link

@KancerEzeroglu KancerEzeroglu commented Aug 12, 2020

Just to confirm, I'll enrich the current document(https://www.netlifycms.org/docs/custom-widgets/#registerwidget), with the steps mentioned in the repo read me (https://github.com/netlify/netlify-cms-widget-starter).
Is that ok?

@erezrokah
Copy link
Collaborator Author

@erezrokah erezrokah commented Aug 12, 2020

Yes, that's great. I recommend opening a PR (could be a draft) as soon as you have something in order to get some feedback.

Let's me know if you starting working on it and I can assign the issue to you.

@KancerEzeroglu
Copy link

@KancerEzeroglu KancerEzeroglu commented Aug 13, 2020

hi @erezrokah ,
I've started to work on it yesterday, fyi

@erezrokah erezrokah added this to Triage in Priority Issues via automation Aug 13, 2020
@erezrokah erezrokah moved this from Triage to In Progress in Priority Issues Aug 13, 2020
@KancerEzeroglu
Copy link

@KancerEzeroglu KancerEzeroglu commented Aug 13, 2020

Hi @erezrokah ,
I prepared the first iteration as a draft.
You can check it out. After your review, I can address your comments :)

@erezrokah
Copy link
Collaborator Author

@erezrokah erezrokah commented Aug 13, 2020

Thanks @KancerEzeroglu, if you open a PR for it Netlify will generate a preview template with your version of the site. That would make it easier to review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Priority Issues
In Progress
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.