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

Add samples as init template #2

Merged
merged 2 commits into from
Feb 11, 2025
Merged

Conversation

infotexture
Copy link
Member

@infotexture infotexture commented Feb 9, 2025

Description

This pull request adds the DITA garage samples and Ant build scripts from docsrc/samples/ as a new samples template:

Motivation and Context

  • This pull request serves as an illustration of how users could contribute a new set of template files to the init plug-in.

    A link to this PR could be referenced in the docs.

  • If this PR is merged, we could remove the garage samples from docsrc/samples folder of the distribution package.

    We could then explain in the documentation how to use the init plug-in to restore them if necessary.
    This example would show how the init plug-in works.

How Has This Been Tested?

  • Made a .zip file of my local copy of the init plug-in, and installed it
  • Temporarily removed the garage samples from my docs clone
  • Ran dita init samples -o /path/to/docs/samples
    ✅ Sample files re-appeared as expected
  • Verified that the restored files are identical to those that were removed
    ✅ Git worktree clean

Type of Changes

  • New feature (non-breaking change which adds functionality)

Documentation and Compatibility

  • What documentation changes are needed for this feature?
    • Add info to Migration section and 4.3 Release Notes to describe the changes.
  • Will this change affect backwards compatibility or other users' overrides?
    • Since this plug-in itself is new, there are no issues with backwards compatibility
    • If the samples are removed from the docs, any user scripts that rely on them would fail, but we can provide instructions for restoring them, so this shouldn't be a problem.

Signed-off-by: Roger Sheen <roger@infotexture.net>
@infotexture infotexture added the enhancement New feature or request label Feb 9, 2025
@infotexture infotexture self-assigned this Feb 9, 2025
@infotexture infotexture changed the title Add garage samples as init template Add samples as init template Feb 10, 2025
Signed-off-by: Roger Sheen <roger@infotexture.net>
infotexture added a commit to dita-ot/docs that referenced this pull request Feb 11, 2025
This removes the old Ant samples and garage samples from the
`docsrc/samples` subfolder of the default DITA-OT distribution package.

Follow-up to dita-ot/org.dita.init#2, which will
allow them to be restored as necessary from the
[org.dita.init](dita-ot/org.dita.init#2) plugin
via the new `init` subcommand:

```shell
dita init samples
```
@infotexture infotexture merged commit 3e607ca into develop Feb 11, 2025
1 check passed
@infotexture infotexture deleted the feature/garage-samples branch February 11, 2025 23:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants