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

Update image and migration guides #15010

Closed
godai78 opened this issue Sep 15, 2023 · 5 comments · Fixed by #15024
Closed

Update image and migration guides #15010

godai78 opened this issue Sep 15, 2023 · 5 comments · Fixed by #15024
Assignees
Labels
squad:core Issue to be handled by the Core team. type:docs This issue reports a task related to documentation (e.g. an idea for a guide).

Comments

@godai78
Copy link
Contributor

godai78 commented Sep 15, 2023

Add info about automatic height and width to image guide.

@godai78 godai78 added squad:core Issue to be handled by the Core team. type:docs This issue reports a task related to documentation (e.g. an idea for a guide). labels Sep 15, 2023
@godai78 godai78 self-assigned this Sep 15, 2023
@CKEditorBot CKEditorBot added the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Sep 19, 2023
godai78 added a commit that referenced this issue Sep 21, 2023
Docs: adding width and height info yo image guide. Closes: #15010
@CKEditorBot CKEditorBot removed the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Sep 21, 2023
@CKEditorBot CKEditorBot added this to the iteration 67 milestone Sep 21, 2023
@Witoso
Copy link
Member

Witoso commented Oct 5, 2023

I would give a bit more of ❤️ to the migration guide. It's a huuuge change, and if I were an integrator, I think I would miss it.

  1. I would prioritize bullet points over long sentences. I'm a bit lost to the narrative. Add some bolds.
  2. I truly miss the HTML here (before/after) the markups changes are important.
    1. Show even two scenarios (without resize / with resize)
    2. I would reference maybe: https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/installation/plugins/features-html-output-overview.html
    3. explanation why we added aspect-ratio, this is an unusual style decision.
  3. Inform the API integrators in more details on the attributes changes.
  4. Better explanation about the content styles changes (and potentially why they were needed).
  5. And I think the most significant piece, add info that current images are not altered.

I think the comment, could be copied and pasted and slightly tweaked.

We shouldn't be afraid of the length of this page, it's a special one, and we can go into weeds 😊

cc @Reinmar as we discussed this.

@Witoso Witoso reopened this Oct 5, 2023
@CKEditorBot CKEditorBot added status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. and removed status:planned Set automatically when an issue lands in the "Sprint backlog" column. We will be working on it soon. labels Oct 6, 2023
@godai78
Copy link
Contributor Author

godai78 commented Oct 6, 2023

2. I truly miss the HTML here (before/after) the markups changes are important.

Wouldn't the Migration guide be the best place for that?

@Witoso
Copy link
Member

Witoso commented Oct 6, 2023

I would give a bit more of ❤️ to the migration guide

All of the comments are to the migration guide :) sorry for not making it clear.

@godai78
Copy link
Contributor Author

godai78 commented Oct 6, 2023

I have just redone the whole part of the image guide, Witek.

Actually I think we'll keep it anyway.

@godai78
Copy link
Contributor Author

godai78 commented Oct 9, 2023

don't close the issue to add a HTML markup as a follow-up.

@godai78 godai78 changed the title Update image guides Update image and migration guides Oct 9, 2023
@CKEditorBot CKEditorBot removed the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Oct 10, 2023
@CKEditorBot CKEditorBot added the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Oct 25, 2023
@CKEditorBot CKEditorBot removed the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Oct 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
squad:core Issue to be handled by the Core team. type:docs This issue reports a task related to documentation (e.g. an idea for a guide).
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants