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

Add instructions for the UMD build to the Quick start guide #17028

Merged
merged 8 commits into from
Sep 12, 2024

Conversation

filipsobol
Copy link
Member

Suggested merge commit message (convention)

Docs: Add instructions for the UMD build to the Quick start guide.


Additional information

For example – encountered issues, assumptions you had to make, other affected tickets, etc.

@Witoso
Copy link
Member

Witoso commented Sep 2, 2024

Please sync this with what @gorzelinski started to prepare in the cloud branch.

godai78
godai78 previously approved these changes Sep 3, 2024
Copy link
Contributor

@godai78 godai78 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. We must keep in mind Melman sync for this, too.

Copy link
Contributor

@gorzelinski gorzelinski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a few comments.

docs/getting-started/quick-start.md Outdated Show resolved Hide resolved
docs/getting-started/quick-start.md Outdated Show resolved Hide resolved
docs/getting-started/quick-start.md Outdated Show resolved Hide resolved
docs/getting-started/quick-start.md Outdated Show resolved Hide resolved
docs/getting-started/quick-start.md Outdated Show resolved Hide resolved
@Witoso
Copy link
Member

Witoso commented Sep 3, 2024

@gorzelinski is this similar to what you have on your branch? I feel we are touching this from different angles, but I'm not sure.

@gorzelinski
Copy link
Contributor

gorzelinski commented Sep 3, 2024

@gorzelinski is this similar to what you have on your branch? I feel we are touching this from different angles, but I'm not sure.

Here's a table of contents of the vanilla js cloud quick start on the epic branch. There is an "Installing CKEditor 5 from CDN" section where I describe the usage with global variables and UMD modules. The "Installing premium features from CDN" is the same but for premium features.

The "Advanced setup with import maps" section contains the setup with import maps and ES Modules (for both - open-source and premium features).

So, the sections are similar. However, nowhere in the guide do I mention "build," "UMD," or "ES modules" directly.

Screenshot 2024-09-03 at 11 28 51

godai78
godai78 previously approved these changes Sep 6, 2024
godai78
godai78 previously approved these changes Sep 11, 2024
gorzelinski
gorzelinski previously approved these changes Sep 11, 2024
Copy link
Contributor

@gorzelinski gorzelinski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

docs/getting-started/quick-start.md Outdated Show resolved Hide resolved
@godai78 godai78 dismissed stale reviews from gorzelinski and themself via c96101f September 11, 2024 07:45
@filipsobol filipsobol merged commit 18ab27a into stable Sep 12, 2024
9 checks passed
@filipsobol filipsobol deleted the docs-add-umd-build-to-quick-start branch September 12, 2024 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants