Dave Barnes created GEODE-10233:
-----------------------------------
Summary: User guide: Improve format of cache elements and
client-cache elements reference pages
Key: GEODE-10233
URL: https://issues.apache.org/jira/browse/GEODE-10233
Project: Geode
Issue Type: Improvement
Components: docs
Affects Versions: 1.14.4
Reporter: Dave Barnes
The reference pages for cache.xml and client_cache.xml use 3-column tables to
describe their respective elements.
* https://geode.apache.org/docs/guide/114/reference/topics/cache_xml.html
* https://geode.apache.org/docs/guide/114/reference/topics/client-cache.html
Problem: Almost all content is confined to Column 2. Columns 1 and 3 contain
very little content. Column 2 even contains nested tables and sample code. This
presentation is very hard to read, and very hard to search or browse.
For example, see the table in cache_xml.html describing
<region-attributes> attributes.
Solution: Devise a better format that's easier to read and better adapted to
searching and browsing. An outline structure with headings, subheadings, and
paragraphs would be one suggestion.
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
