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

Optimize RTE page #398

Merged
merged 11 commits into from
Nov 14, 2023
Merged

Optimize RTE page #398

merged 11 commits into from
Nov 14, 2023

Conversation

sypets
Copy link
Contributor

@sypets sypets commented Nov 8, 2023

Main point it to add examples for setting a preset via page TSconfig.

Additionally, the following changes are made:

  • add a header for the examples (since examples are now extended and this improves finding the examples when skimming the page)
  • add clarification what "order" (for the presets) means. If not familiar with TYPO3 one might assume, the order means that the later settings overrides the previous which is not the case: once a setting is set, the ones following it are ignored.
  • clarify what default (number 4. in the listing of "order") means
  • add some links

Note to reviewers:

  • I have not set the backport labels. I think this can be backported as is, but should double check
  • Please check if this actually improves the clarity. I found some parts to be a little vague but adding extra text always has the problem that it clutters up the page and makes it less terse which might even impact the clarity negatively

Main point it to add examples for setting a preset via page TSconfig.

Additionally, the following changes are made:

- add a header for the examples (since examples are now extended
  and this improves finding the examples when skimming the page)
- add clarification what "order" (for the presets) means. If not
  familiar with TYPO3 one might assume, the order means that the
  later settings overrides the previous which is not the case:
  once a setting is set, the ones following it are ignored.
- clarify what default (number 4. in the listing of "order")
  means
- add some links
@brotkrueml brotkrueml self-requested a review November 8, 2023 07:39
@brotkrueml
Copy link
Contributor

@sypets Thanks for your work 👍

@brotkrueml brotkrueml merged commit 64d90c0 into TYPO3-Documentation:main Nov 14, 2023
3 checks passed
Copy link
Contributor

The backport to 11.5 failed:

The process '/usr/bin/git' failed with exit code 1
stderr
error: could not apply b1e49fb... Optimize RTE page
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".

stdout
Auto-merging Documentation/PageTsconfig/Rte.rst
Auto-merging Documentation/Settings.cfg
CONFLICT (content): Merge conflict in Documentation/Settings.cfg

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-11.5 11.5
# Navigate to the new working tree
cd .worktrees/backport-11.5
# Create a new branch
git switch --create backport-398-to-11.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick b1e49fb7e10b1603767323a3825e4235c0d24d58,84bd8b85b3d7df14504c4cc7a8ea25ab1172767c,2abaebddcfab65e33338bc84da6c9ae01e371a53,d4917cba94c0b16360a86b562d82b5220163019b,8acaa874f2e476b84957a7d3351fee284a4f1bc7,9849e33e1450b600d5f30ae71813102de6ba2761,062f49e903e40cf68e6c76cf4a38033b34f83d79,5b0b5194838efceec04d61b3d0f5a2545456df66,56824531e9f4909d841dff9a5986f6c1c184c6f2,85c9fa3fde878b2eabcbf9058f1027246373dbcb,d2f9b1b3eca7d48b50edb410c42b2b2f989a115e
# Push it to GitHub
git push --set-upstream origin backport-398-to-11.5
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-11.5

Then, create a pull request where the base branch is 11.5 and the compare/head branch is backport-398-to-11.5.

Copy link
Contributor

The backport to 12.4 failed:

The process '/usr/bin/git' failed with exit code 1
stderr
error: could not apply b1e49fb... Optimize RTE page
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".

stdout
Auto-merging Documentation/PageTsconfig/Rte.rst
Auto-merging Documentation/Settings.cfg
CONFLICT (content): Merge conflict in Documentation/Settings.cfg

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-12.4 12.4
# Navigate to the new working tree
cd .worktrees/backport-12.4
# Create a new branch
git switch --create backport-398-to-12.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick b1e49fb7e10b1603767323a3825e4235c0d24d58,84bd8b85b3d7df14504c4cc7a8ea25ab1172767c,2abaebddcfab65e33338bc84da6c9ae01e371a53,d4917cba94c0b16360a86b562d82b5220163019b,8acaa874f2e476b84957a7d3351fee284a4f1bc7,9849e33e1450b600d5f30ae71813102de6ba2761,062f49e903e40cf68e6c76cf4a38033b34f83d79,5b0b5194838efceec04d61b3d0f5a2545456df66,56824531e9f4909d841dff9a5986f6c1c184c6f2,85c9fa3fde878b2eabcbf9058f1027246373dbcb,d2f9b1b3eca7d48b50edb410c42b2b2f989a115e
# Push it to GitHub
git push --set-upstream origin backport-398-to-12.4
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-12.4

Then, create a pull request where the base branch is 12.4 and the compare/head branch is backport-398-to-12.4.

brotkrueml pushed a commit to brotkrueml/TYPO3CMS-Reference-TSconfig that referenced this pull request Nov 14, 2023
Main point it to add examples for setting a preset via page TSconfig.

Additionally, the following changes are made:

- add a header for the examples (since examples are now extended
  and this improves finding the examples when skimming the page)
- add clarification what "order" (for the presets) means. If not
  familiar with TYPO3 one might assume, the order means that the
  later settings overrides the previous which is not the case:
  once a setting is set, the ones following it are ignored.
- clarify what default (number 4. in the listing of "order")
  means
- add some links
brotkrueml added a commit that referenced this pull request Nov 14, 2023
Main point it to add examples for setting a preset via page TSconfig.

Additionally, the following changes are made:

- add a header for the examples (since examples are now extended
  and this improves finding the examples when skimming the page)
- add clarification what "order" (for the presets) means. If not
  familiar with TYPO3 one might assume, the order means that the
  later settings overrides the previous which is not the case:
  once a setting is set, the ones following it are ignored.
- clarify what default (number 4. in the listing of "order")
  means
- add some links

Co-authored-by: Sybille Peters <sypets@gmx.de>
brotkrueml added a commit to brotkrueml/TYPO3CMS-Reference-TSconfig that referenced this pull request Nov 14, 2023
Main point it to add examples for setting a preset via page TSconfig.

Additionally, the following changes are made:

- add a header for the examples (since examples are now extended
  and this improves finding the examples when skimming the page)
- add clarification what "order" (for the presets) means. If not
  familiar with TYPO3 one might assume, the order means that the
  later settings overrides the previous which is not the case:
  once a setting is set, the ones following it are ignored.
- clarify what default (number 4. in the listing of "order")
  means
- add some links

Co-authored-by: Sybille Peters <sypets@gmx.de>
brotkrueml added a commit that referenced this pull request Nov 14, 2023
Main point it to add examples for setting a preset via page TSconfig.

Additionally, the following changes are made:

- add a header for the examples (since examples are now extended
  and this improves finding the examples when skimming the page)
- add clarification what "order" (for the presets) means. If not
  familiar with TYPO3 one might assume, the order means that the
  later settings overrides the previous which is not the case:
  once a setting is set, the ones following it are ignored.
- clarify what default (number 4. in the listing of "order")
  means
- add some links

Co-authored-by: Sybille Peters <sypets@gmx.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants