<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:14:28 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary add field=key&field=summary to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>FOLIO Jira</title>
    <link>https://folio-org.atlassian.net</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>1001.0.0-SNAPSHOT</version>
        <build-number>100246</build-number>
        <build-date>07-02-2024</build-date>
    </build-info>

<item>
            <title>[FOLIO-1592] Improve the table-of-contents for API Documentation reference</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-1592</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;The &lt;a href=&quot;https://dev.folio.org/reference/api/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;dev.folio.org/reference/api/&lt;/a&gt; list of raml-related back-end modules has suddenly increased in number (now 44 on 2018-10-23).&lt;/p&gt;

&lt;p&gt;The left-hand ToC becomes cumbersome.&lt;/p&gt;

&lt;p&gt;Find a way to group them.&lt;/p&gt;</description>
                <environment></environment>
        <key id="80959">FOLIO-1592</key>
            <summary>Improve the table-of-contents for API Documentation reference</summary>
                <type id="10002" iconUrl="https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10322?size=medium">New Feature</type>
                                            <priority id="10002" iconUrl="https://dev.folio.org/assets/jira-priority/jira-p3.svg">P3</priority>
                        <status id="6" iconUrl="https://folio-org.atlassian.net/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="green"/>
                                    <resolution id="10003">Done</resolution>
                                                        <assignee accountid="61cd0ca0bce5e00069e98be7">David Crossley</assignee>
                                                                <reporter accountid="61cd0ca0bce5e00069e98be7">David Crossley</reporter>
                                    <labels>
                            <label>devweb</label>
                    </labels>
                <created>Tue, 23 Oct 2018 07:43:28 +0000</created>
                <updated>Mon, 12 Nov 2018 14:25:13 +0000</updated>
                            <resolved>Fri, 9 Nov 2018 07:37:57 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>1</watches>
                                                                <comments>
                                                            <comment id="192835" author="61cd0ca0bce5e00069e98be7" created="Tue, 23 Oct 2018 07:44:36 +0000"  >&lt;p&gt;The ToC is automatically generated by &lt;a href=&quot;https://github.com/tscanlin/tocbot&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;tocbot&lt;/a&gt; JS using the &lt;tt&gt;h1..h4&lt;/tt&gt; html headings in the page content.&lt;/p&gt;

&lt;p&gt;The page is generated from the &lt;a href=&quot;https://github.com/folio-org/folio-org.github.io/blob/master/_data/api.yml&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;_data/api.yml&lt;/a&gt; data file, by the Liquid programming language behind &lt;tt&gt;/reference/api/index.md&lt;/tt&gt; (which has some limitations, but can utilise Ruby plugins (and home-grown) and other data files).&lt;/p&gt;

&lt;p&gt;Each module entry in the list is added to the page as an h3 heading and associated table. Encompassing groups of modules in an h2 heading will enable the ToC to automatically expand and collapse for each group.&lt;/p&gt;

&lt;p&gt;How to group them?&lt;/p&gt;

&lt;p&gt;Some possible solutions:&lt;/p&gt;

&lt;p&gt;A) Functional categories. Add a &quot;category&quot; parameter to each entry in the api.yml configuration file. Defining the list of relevant categories is the difficult part. Leaving this solution until later. Perhaps utilise categories from the upcoming &quot;App store&quot;. Or commence a set of categories, and modify later.&lt;/p&gt;

&lt;p&gt;B) Alphabetic groups. The Liquid could automatically split the list into equal-sized groups based on module name: Modules A, Modules B, etc. Probably sort each &quot;edge-&quot; one with the relevant &quot;mod-&quot; ones.&lt;/p&gt;

&lt;p&gt;C) Batches. The Liquid could automatically split the list into equal-sized batches, just crudely splitting sequentially into sets of say 6 modules. The api.yml list would have similar function modules ordered near each other to assist the batching.&lt;/p&gt;</comment>
                                                            <comment id="192838" author="61cd0ca0bce5e00069e98be7" created="Tue, 23 Oct 2018 07:44:54 +0000"  >&lt;p&gt;Option C is the easiest and more useful than Option B, so doing that for now.&lt;/p&gt;</comment>
                                                            <comment id="192839" author="61cd0ca0bce5e00069e98be7" created="Tue, 23 Oct 2018 07:47:59 +0000"  >&lt;p&gt;Also investigating ways to automate and delegate the configuration.&lt;/p&gt;</comment>
                                                            <comment id="192841" author="61cd0ca0bce5e00069e98be7" created="Mon, 5 Nov 2018 09:54:02 +0000"  >&lt;p&gt;Now done Option A. Using list of groups in &lt;a href=&quot;https://github.com/folio-org/folio-org.github.io/blob/master/_data/apigroup.yml&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;_data/apigroup.yml&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                                                <inwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="79379">FOLIO-903</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10000" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummarycf">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10019" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0|hzz2xr:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10020" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10025" key="com.atlassian.jira.ext.charting:timeinstatus">
                        <customfieldname>[CHART] Time in Status</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                    </customfields>
    </item>
</channel>
</rss>