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 #3565

Draft
wants to merge 13 commits into
base: tinymce/7
Choose a base branch
from

Conversation

FarzadHayat
Copy link
Contributor

@FarzadHayat FarzadHayat commented Dec 23, 2024

Ticket: DOC-1928

Site: Staging branch
Site: Visual DOM Diff (columns left to right: before, after, diff)

Changes:

  • Use consistent values for option value Types
    • +String+, +Boolean+, +Number+, +Function+, +Object+, +Array+, +RegExp+, +null+, +undefined+
  • Use consistent structure for option files:
    1. Option heading
    2. Option description
    3. Type
    4. Possible values
    5. Default value
    6. Example(s)
  • Fix indentation in tables to improve readability
  • Convert === Example: ... sections to .Example: ... to prevent them from showing up in the page-specific nav list
  • Update template files for configuration option
  • Fix grammar errors
  • Fix indentation of page nav elements
  • Fix inline code styling inside admonitions
  • Add usage of btn, kbd, and menu Antora UI Macros
  • Fix incorrect option descriptions
    • typography_default_lang array to string
    • typography_langs object to array
    • anchor_bottom missing false type
    • anchor_top missing false type
    • auto_focus missing true type
    • block_formats default value
    • tinycomments_access possible values
    • content_css type and default value
    • custom_elements type
    • directionality incomplete default value
    • doctype missing type, default value, example
    • entity_encoding possible values
    • mentions_selector wrong type and missing default value
    • menubar incomplete default value
    • nonbreaking_force_tab missing number type
    • noneditable_regexp wrong type
    • object_resizing wrong default value
    • powerpaste_googledocs_import missing possible values
    • powerpaste_html_import missing function type and possible values
    • powerpaste_word_import missing possible values
    • revisionhistory_author missing default value
    • spellchecker_languages missing possible values and wrong default value
    • table_grid incomplete default value
    • tableofcontents_depth missing possible values
    • tableofcotents_header missing possible values
    • color_default_background missing default value
    • color_default_foreground missing default value
    • toolbar_mode incomplete default value
    • video_template_callback wrong type

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

@FarzadHayat FarzadHayat self-assigned this Dec 23, 2024
@FarzadHayat FarzadHayat marked this pull request as ready for review January 2, 2025 02:09
@FarzadHayat FarzadHayat mentioned this pull request Jan 2, 2025
12 tasks
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.

No breaking changes or any confusion in new responses or heading changes. LGTM!

@FarzadHayat FarzadHayat marked this pull request as draft January 7, 2025 22: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.

2 participants