next-cloudinary icon indicating copy to clipboard operation
next-cloudinary copied to clipboard

[Feature] Update CldVideoPlayer Configuration Docs to Table component

Open colbyfayock opened this issue 1 year ago • 8 comments

Feature Request

Is your feature request related to a problem? Please describe.

Most of the CldVideoPlayer configuration docs is using the markdown format of defining a table.

image

The newer style uses a Table component, looking like this

image

Migrate all CldVideoPlayer configuration tables in the markdwon format to the Table component. See the Advanced section as an example of the Table component format.

colbyfayock avatar Sep 13 '24 02:09 colbyfayock

@colbyfayock curious, is this up for grabs?

Neilblaze avatar Sep 21 '24 07:09 Neilblaze

Sure, all yours!

colbyfayock avatar Sep 21 '24 10:09 colbyfayock

@colbyfayock, I'm facing some hiccups while running the /docs locally. I'm curious, do we need to follow this, i.e. we need to ensure that NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME is set and configured in our environment even for the docs to fire up?

Here're two snaps for reference: image

image

P.S.: I'm currently on Windows 10 Pro (x64) & using pnpm

Neilblaze avatar Sep 24 '24 01:09 Neilblaze

the Docs uses Next Cloudinary to display all of the examples and the demos and the library requires the Cloud Name to be configured.

theoretically you could add a random value as a cloud name, but the images and videos just won't work on the site. for this particular task, that's not necessarily important, as the Configuration page doesn't include any images or videos

colbyfayock avatar Sep 24 '24 02:09 colbyfayock

The issue which I'm still facing is that, even though I used a dummy string as the cloud name, the pnpm run dev command is returning the same compile error on my local.

Screenshots:

image

image

Any solution for this?

Neilblaze avatar Sep 24 '24 05:09 Neilblaze

oh that seems like a bit different of an error. can you try running pnpm run build in the next-cloudinary directory, run pnpm dev in the same in a new tab, or you may be able to run pnpm dev from the root

i think the library just needs to be built

colbyfayock avatar Sep 24 '24 15:09 colbyfayock

Followed your instructions, here's what I found:

  1. The pnpm run build in the next-cloudinary is working fine and build seems to be successful image

  2. But then, when I run pnpm dev inside the same directory (after following step-1), it freezes at this — image

  3. I tried to execute pnpn dev from the root, but it's not working since there's no dev script in the package.json

any idea on what I should do next?

Neilblaze avatar Sep 24 '24 16:09 Neilblaze

#2 with pnpm dev should be accurate, unless im missing something. its showing the build was successful and now it's waiting for changes. so the idea would be you keep that tab open if any changes are made to the next-cloudinary directory, it will rebuild. if you're not making any changes, just building should suffice, and the docs should then be okay to run

colbyfayock avatar Sep 24 '24 17:09 colbyfayock

@Neilblaze any updates?

colbyfayock avatar Oct 11 '24 15:10 colbyfayock

@colbyfayock Apologies for the delay, I'll create a PR by today 🙏🏼 Also, a tiny additional request, can we mark this issue as a Hacktoberfest 2024 eligible issue, please?

Neilblaze avatar Oct 12 '24 17:10 Neilblaze

thanks @Neilblaze - the entire repo is opted into hacktoberfest so should be good :)

colbyfayock avatar Oct 14 '24 15:10 colbyfayock

Sounds good, thanks! 😃

Neilblaze avatar Oct 14 '24 20:10 Neilblaze

:tada: This issue has been resolved in version 6.16.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

github-actions[bot] avatar Oct 22 '24 17:10 github-actions[bot]

:tada: This issue has been resolved in version 7.0.0-beta.5 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

github-actions[bot] avatar Oct 25 '24 18:10 github-actions[bot]