Docs: Clean up formatting of "Easing gently into OpenSRF"

Bug #1599600 reported by Remington Steed
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Evergreen
Undecided
Unassigned

Bug Description

The very helpful article "Easing gently into OpenSRF" (by Dan Scott) needs some reformatting. Especially:

  - Improve the number references used in code examples (currently using images, which need better styling or should be replaced with text)
  - Other included images are too large (such as REQUEST.png and CONNECT.png)

http://docs.evergreen-ils.org/dev/_introducing_opensrf.html

Changed in evergreen:
assignee: nobody → Jeanette Lundgren (jlundgren)
status: New → In Progress
Revision history for this message
Jeanette Lundgren (jlundgren) wrote :

I am not 100% sure the syntax changes on the source callouts is fixed. I am unable to convert asciidoc to html, but it is rending correctly in asiidoc. I can update to plain text numbers if this doesn't work.

The two images have also been resized.

Changes pushed to working repo @
http://git.evergreen-ils.org/?p=working/Evergreen.git;a=commit;h=4ee930668cb9a2c9f0dd91035bea1a60265d8dff

Changed in evergreen:
assignee: Jeanette Lundgren (jlundgren) → nobody
tags: added: pullrequest
Revision history for this message
Remington Steed (rjs7) wrote :

Thanks for working on this, Jeanette! The resized images are great.

Unfortunately, the AsciiDoc changes aren't quite the right idea. Each code language needs a different callout syntax, so those need to stay as they were. I think we can fix the messy image style by removing or rethinking the following style from evergreen_doc.css:

img {
    margin-bottom: 25px;
}

That isn't in the code repo, so it would need to be adjusted on the live docs server.

Also, the callout images got deleted from 2.12+ at some point. Though the 2.12 doc looks fine (at least in Firefox), the page generates lots of "404 Not Found" errors for the missing images. So those images should be added back to the repo, unless of course the commit that removed them explained why they were deleted.

tags: removed: pullrequest
Revision history for this message
Remington Steed (rjs7) wrote :

Rather than spend time worrying about formatting this in AsciiDoc, I am exploring converting this to DokuWiki as part of the Developer Docs project. Marking this as "Won't Fix" for now.

Changed in evergreen:
status: In Progress → Won't Fix
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers