Docs: Use asciidoc attributes for upgrade docs to simplify updating
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Evergreen |
Confirmed
|
Undecided
|
Unassigned |
Bug Description
Asciidoc has the ability to setup attributes that can be used as variables in the docs. I've been toying with the idea of using them to make it easier for the upgrading docs to be updated between versions, and possibly the install docs also.
Docs for document attributes
http://
And a gotcha about attributes in listing blocks is documented at
http://
One of the issue with this is that it makes the plain text source of the asciidoc less readable for those that may open it with the text editor. I personally use the web version of the docs, so this doesn't bother me. But maybe that is a deal breaker for others.
This make make auto-editing the file easier, since you wouldn't need to worry about search and replace issues with the sql upgrade script names.
Josh
Changed in evergreen: | |
status: | New → Confirmed |
tags: | added: pullrequest |
user/stompro/ lp1487123_ upgrade_ docs_attributes
http:// git.evergreen- ils.org/ ?p=working/ Evergreen. git;a=shortlog; h=refs/ heads/user/ stompro/ lp1487123_ upgrade_ docs_attributes
Here is a branch that sets up attributes for the version numbers that change between versions. I think the sql scripts will still need to be adjusted.. Hopefully an automatic DB upgrade process will take over sometime so we don't have to list those out as examples. Maybe there already is one?
Josh