Skip to content

Conversation

@shaneataylor
Copy link
Contributor

To facilitate using the samples files for examples in the documentation, moving these files out of the dita-ot repo and into the docs repo.

@jelovirt
Copy link
Member

@infotexture @robander this is your call, I have no strong feelings about samples, other than they should not be a submodule (due to added management complexity).

@infotexture
Copy link
Member

👍 I'm inclined to merge this, as I think it makes sense to treat samples as part of the documentation (which references them) rather than as core OT code.

Per discussion in dita-ot/dita-ot#2205, this would make it easier for the docs team to maintain samples, generate new sample content and reference samples via <coderef>.

@infotexture
Copy link
Member

@shaneataylor: This changes the path to samples in distribution packages to docsrc/samples.

Would you be able to extend this PR with a new commit that updates creating-an-ant-build-script.dita and using-dita-command.dita accordingly?

@infotexture infotexture mentioned this pull request Jan 22, 2016
12 tasks
@infotexture infotexture added the refactoring Changes to organization of docs source label Jan 22, 2016
@shaneataylor
Copy link
Contributor Author

@infotexture: Will do.

@jelovirt, @infotexture: What do you think about either updating the docs build to copy docsrc/samples to its accustomed location for increased findability, or making a samples symlink to docsrc/samples in the distros (although I'm not sure how to do this for Windows)?

@infotexture
Copy link
Member

@shaneataylor: Thanks.

Not sure we really need to copy the content to its old location, as the docsrc/samples folder will be included in the distribution packages, plus any topics referenced there from the root map in docs would also appear in the output folder doc/samples.

Not sure how many people discover samples by peeking into distribution subfolders, but I think as long as the docs refer to the new location, we should be fine.

@shaneataylor
Copy link
Contributor Author

@infotexture I updated the topics and I'm fine with the move from samples to docsrc/samples.

infotexture added a commit that referenced this pull request Jan 24, 2016
Add `samples` files from the parent DITA-OT repo
@infotexture infotexture merged commit 2cebf11 into dita-ot:develop Jan 24, 2016
@infotexture infotexture added this to the 2.3 milestone Jan 24, 2016
@shaneataylor shaneataylor deleted the add_samples_from_ot branch January 26, 2016 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

refactoring Changes to organization of docs source

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants