[5pt] Put all included content in _include directories
Open
Nobody has claimed this yet.
internal
translate
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Put all included content in _include directories
Reviewer: @NickVolynkin
Sometimes we extract big chunks of documentation to separate files and then include them with .. include::. When we do so, we should put included files in an _include directory next to the parent document.
If we don't, there are several consequenses:
- Included files get built and become separate pages.
- Building has warnings about files not in the toctree.
- Files produce .pot and .po files which go to Crowdin and count as untranslated.
DoD
- Move all included files in
_includedirectories next to parent documents. - Change paths to include them in the parent documents
- Remove relevant
.potand.pofiles from the repository. If there are translations in the removed.pofiles, check if they're also in the parents'.pofiles. Check that we don't lose translations in the output. - @NickVolynkin: push to Crowdin to remove files, check results.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the documentation for .. include:: references and inspect each included file, its parent document, and related .pot and .po files. Move included content into adjacent _include directories, update parent paths, verify translations are preserved, and coordinate the Crowdin removal check with @NickVolynkin.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, localization
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100