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: Use npx degit instead of git clone in tutorials #17232

Merged
merged 3 commits into from
Oct 9, 2024

Conversation

filipsobol
Copy link
Member

Suggested merge commit message (convention)

Docs: Use npx degit instead of git clone in tutorials. See #17182.


Additional information

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

@filipsobol
Copy link
Member Author

filipsobol commented Oct 7, 2024

The npx commands are often too long because of the long files paths.

Code snippet

This is an issue because the code snippet cannot be copied using the “Copy” button, as these commands are supposed to be run consecutively.

One way to fix this it to rename the repository from ckeditor5-tutorials-examples to ckeditor5-tutorials or even just tutorials and change the folder names. How do you feel about this? @Witoso @gorzelinski

@Witoso
Copy link
Member

Witoso commented Oct 9, 2024

IMHO, let's first merge asap, as there's another issue reported: #17239

Witoso
Witoso previously approved these changes Oct 9, 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.

I added some nitpicks. The commands should work as expected. I like the idea of shortening the file paths.

docs/tutorials/crash-course/editor.md Outdated Show resolved Hide resolved
docs/tutorials/widgets/using-react-in-a-widget.md Outdated Show resolved Hide resolved
@filipsobol filipsobol merged commit 989947d into master Oct 9, 2024
10 checks passed
@filipsobol filipsobol deleted the docs-use-degit-in-tutorials branch October 9, 2024 13:44
filipsobol added a commit that referenced this pull request Oct 9, 2024
Docs: Use `npx degit` instead of `git clone` in tutorials. See #17182.
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.

3 participants