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

DOC-1928: Clean up partials/configuration directory #3592

Open
wants to merge 2 commits into
base: tinymce/7
Choose a base branch
from

Conversation

FarzadHayat
Copy link
Contributor

@FarzadHayat FarzadHayat commented Feb 4, 2025

Ticket: DOC-1928

Site: Staging branch

I recreated the original PR and retained only the essential changes that are fixing something with factual inaccuracy or visual bug. This PR is oly 46 files with small changes in each, so it is easier to review. All changes in this PR have been visually checked for correction using a side-by-side comparison between tinymce/7 and hotfix/7/DOC-1928_3.

Changes:

  • Fix basic setup example for Typography plugin
  • Refactor custom sidebar spec object into a table
  • Fix incomplete sidebar_show code example
  • Change typography_langs type from Object to Array
  • Fix language name typo Servian to Serbian
  • Add missing false type to anchor_bottom and anchor_top
  • Add missing true type to auto_focus
  • Add missing code example for auto_focus: true
  • Add missing default value for autoresize_bottom_margin
  • Add missing default value for autoresize_overflow_padding
  • Add missing possible and default value full for tinycomments_access
  • Add missing default value for content_css
  • Add missing Object type for custom_elements
  • Fix incomplete code example for custom_ui_selector
  • Fix incomplete default value for directionality
  • Add missing type, default value, and code example for doctype
  • Fix incorrect type for importword_converter_options from String to Object
  • Remove incorrect sentence from indentation about the default value
  • Add missing false type for insert_toolbar`
  • Fix incorrect type for mentions_selector from Function to String and add default value
  • Add missing Number type for nonbreaking_force_tab
  • Fix incorrect type for noneditable_regexp from String to RegExp
  • Fix incomplete default value for object_resizing
  • Add missing description for pagebreak_separator
  • Add missing code example for powerpaste_allow_local_images
  • Add missing Function type for powerpaste_html_import
  • Fix incomplete default value for resize
  • Add missing false type for selection_toolbar`
  • Fix incomplete default value for table_grid
  • Fix incorrect description and code example for tableofcontents_header
  • Fix broken example block in text_color.adoc
  • Fix incomplete default value for toolbar_mode
  • Fix incorrect type for video_templete_callback from String to Function

Pre-checks:

  • Branch prefixed with feature/<version>/, hotfix/<version>/, staging/<version>/, or release/<version>/.
  • [-] modules/ROOT/nav.adoc has been updated (if applicable).
  • [-] Included a release note entry for any New product features.
  • [-] If this is a minor release, updated productminorversion in antora.yml and added new supported versions entry in modules/ROOT/partials/misc/supported-versions.adoc.

Review:

  • Documentation Team Lead has reviewed

@@ -11,7 +11,7 @@ As of {productname} 7.5.0, the default value of the `exportword_converter_option
.**Default value:**
[source,js]
----
exportword_converter_options: {

Choose a reason for hiding this comment

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

Could you please explain why you removed the exportword_converter_options part in the example. I feel like in the current format was easier to understand with the exportword_converter_options remaining. If the vision is to just say what the default value is maybe not having it a code snippet is easier possibly a sentence.


[NOTE]
As of {productname} 7.5.0, the default value of the `importword_converter_options` setting has been updated to the following:

.**Default value:**
[source,js]
----
importword_converter_options: {

Choose a reason for hiding this comment

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

Similar question to the export_word. I'm just worried that it's a bit confusing to understand with no prior experience to remove that the function in the default value. I see that it's in the example so it's not hard for someone to put it together. If I could get an explanation to the idea of removing the function name, I'd really appreciate it :D

Copy link

@LewisAtTiny LewisAtTiny left a comment

Choose a reason for hiding this comment

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

Overall very good! Just got a question about removing the function names from the default values section

@kemister85
Copy link
Contributor

  • Documentation Team Lead has reviewed- please hold of merging this if possible until i can review.

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.

5 participants