Skip to content

Remove all t2t files, committing generated markdown files in their place, as the new source of truth.#16492

Merged
seanbudd merged 6 commits into
masterfrom
removeT2t
May 7, 2024
Merged

Remove all t2t files, committing generated markdown files in their place, as the new source of truth.#16492
seanbudd merged 6 commits into
masterfrom
removeT2t

Conversation

@seanbudd

@seanbudd seanbudd commented May 7, 2024

Copy link
Copy Markdown
Member

Should be merge commit not squash merge

Link to issue number:

None.

Summary of the issue:

text2tags is now an old file format, and we need to move to something more standard and maintained.
We are already building markdown files from our t2t files for all languages, so we should simply remove the original t2t files and its support, and commit the generated markdown files.

Description of user facing changes

None. The HTML output is the same.

Description of development approach

  • built markdown files for all t2t files.
  • Committed the markdown files, removed removed the t2t files.
  • Updated scons code to start from the markdown files, rather than the t2t files
  • Remove redundant t2t processing

Testing strategy:

  • ran scons user_docs to ensure that html files were produced for all languages.
  • ran scons developerGuide to ensure that the html file builds correctly

Known issues with pull request:

None known.

Code Review Checklist:

  • Documentation:
    • Change log entry: intentionally removed so that this PR only contains formatting changes, an entry will be added later
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

@seanbudd seanbudd added this to the 2024.2 milestone May 7, 2024
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