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

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

Closed
wants to merge 6 commits into from

Conversation

michaelDCurran
Copy link
Member

@michaelDCurran michaelDCurran commented Feb 7, 2024

Blocked until final release of 2024.1.
Merging earlier would cause merge conflicts when merging user docs or translated docs from beta to master.
This must be merged before translations begin on the 2024.2beta

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 the t2t files.
  • Updated scons code to start from the markdown files, rather than the t2t files.
  • Removed the t2t scons tool.

Testing strategy:

  • ran scons user_docs to ensure that html files were produced for all languages.

Known issues with pull request:

None known.

Code Review Checklist:

  • Documentation:
    • Change log entry
    • 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.

@michaelDCurran michaelDCurran requested review from a team as code owners February 7, 2024 22:14
@michaelDCurran michaelDCurran requested review from Qchristensen and SaschaCowley and removed request for a team February 7, 2024 22:14
@seanbudd
Copy link
Member

seanbudd commented Feb 7, 2024

Can you also remove:

  • user_docs\ca\locale.t2tconf
  • site_scons\site_tools\t2t.py
  • t2t filtering in setup.py

@seanbudd
Copy link
Member

seanbudd commented Feb 7, 2024

I'm not sure if we should update the project docs in this PR, but there are references to t2t files in:

  • projectDocs\dev\userGuideStandards.md
  • projectDocs\dev\contributing.md

@seanbudd seanbudd added this to the 2024.1 milestone Feb 7, 2024
* site_scons\site_tools\t2t.py
* Any remaining t2tconf files in user_docs language directories.

Also remove filtering of t2t files in setup.py.
@seanbudd seanbudd modified the milestones: 2024.1, 2024.2 Feb 7, 2024
@michaelDCurran michaelDCurran marked this pull request as draft February 7, 2024 23:05
seanbudd
seanbudd previously approved these changes Feb 7, 2024
sconstruct Outdated Show resolved Hide resolved
sconstruct Outdated Show resolved Hide resolved
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Feb 12, 2024
@SaschaCowley
Copy link
Member

I'm not sure if we should update the project docs in this PR

I think that would be wise: they already need work, so it's probably best to not let them get even further behind.

@seanbudd
Copy link
Member

seanbudd commented May 7, 2024

Closing in favour of #16492

@seanbudd seanbudd closed this May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants