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

No clear pattern for associating related sets of documentation #41

Closed
caldav opened this issue Feb 13, 2017 · 1 comment
Closed

No clear pattern for associating related sets of documentation #41

caldav opened this issue Feb 13, 2017 · 1 comment
Assignees

Comments

@caldav
Copy link
Contributor

caldav commented Feb 13, 2017

The addition of the stacks doc to docs.ubuntu.com/core sets a precedent for merging several doc sources in a single doc build and is not inline with current usage of the platform. We should have platform-wide pattern and tools for these use cases.

cf. canonical/ubuntu-core-docs#8

I am still worried that it sets a bad precedent. I still think that each set of documentation markdown files should be self-contained, and the relationship between markdown repositories and built HTML files should be direct and simple. And this breaks that.

However, we do need a pattern for drawing together related sets of documentation. This should ideally be codified higher up the chain, with core functionality in documentation-builder or in the docs.ubuntu.com application, rather than hacked together with tools like git-repo in individual documentation sets. But unfortunately it doesn't look like creating and implementing the ideal solution can happen in time for this.

@nottrobin nottrobin self-assigned this Feb 13, 2017
@nottrobin
Copy link
Contributor

This issue is quite old, and the landscape of documentation is changing significantly as a result of #86.

I think the current system has been working fine, so for the time being I think we can close this, and just see if a similar issue pops up again in the new structure.

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

No branches or pull requests

2 participants