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

Clean up topics on DITA 1.2 and DITA 1.3 #172

Merged
merged 2 commits into from
Oct 19, 2017

Conversation

robander
Copy link
Member

The content in these topics is quite outdated, and gives no-longer-useful information such as what version of DITA-OT 1.x added specific features of DITA 1.2.

This pull request cleans up the two topics, adds a bit of new information, updates links from the base spec to errata 01, and moves all of the links to keys.

The TOC currently has DITA 1.2 before DITA 1.3, which feels like it's "in order" but I'd suggest flipping that order because 1.3 support is far more important / relevant than 1.2 support at this point. Haven't put that in this pull request though because I know those maps are heavily in flux.

Another long-term cleanup item -- I noticed some of the existing keys for the spec use names like dita-ot-spec but should really be dita-spec or dita13-spec (because it's the DITA spec, not the DITA-OT spec). But that's pretty trivial and I don't want to cause churn by changing at this point.

Robert D Anderson added 2 commits October 19, 2017 09:26
Signed-off-by: Robert D Anderson <robander@us.ibm.com>
Signed-off-by: Robert D Anderson <robander@us.ibm.com>
@robander robander requested a review from infotexture October 19, 2017 14:51
@infotexture
Copy link
Member

🙇 Thanks, very welcome cleanup indeed.

Good call on deferring changes to ToC order. Once #162 lands, we can implement this change (if it's not already included there).

As for changes to spec key names, I'll check how widely they're used outside of these topics to assess the effort/risk of changing them. I have a hunch it'll be worth doing now, but we can treat it as a separate task.

We don't really have a taxonomy in place for key names at this point. They seem to have grown over time with a variety of syntaxes and conventions. Worth harmonizing at some point, but later…

@infotexture infotexture added the outdated content Updates required to reflect recent changes label Oct 19, 2017
@infotexture infotexture added this to the 3.0 milestone Oct 19, 2017
Copy link
Member

@infotexture infotexture left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much better, thanks.

I checked and found the dita-ot-spec* keys are only used in a few other places, so I'll fix those now.

@infotexture infotexture merged commit a1dcce9 into dita-ot:develop Oct 19, 2017
@robander robander deleted the dita13 branch November 8, 2019 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
outdated content Updates required to reflect recent changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants