<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:07:19 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-645] Design improved url-space and navigation content dev.f.o phase 2</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-645</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;Assess the current situation and envisage some future needs.&lt;/p&gt;</description>
                <environment></environment>
        <key id="80250">FOLIO-645</key>
            <summary>Design improved url-space and navigation content dev.f.o phase 2</summary>
                <type id="10003" iconUrl="https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium">Task</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>Wed, 31 May 2017 04:01:14 +0000</created>
                <updated>Mon, 12 Nov 2018 14:23:34 +0000</updated>
                            <resolved>Wed, 4 Apr 2018 01:53:37 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>4</watches>
                                                    <timespent seconds="49500">1 day, 5 hours, 45 minutes</timespent>
                                <comments>
                                                            <comment id="192181" author="61cd0ca0bce5e00069e98be7" created="Mon, 26 Jun 2017 02:15:33 +0000"  >&lt;p&gt;Added &lt;a href=&quot;http://dev.folio.org/doc/#guides&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;doc/#guides&lt;/a&gt; sections as topic groups to assist with navigation.&lt;/p&gt;

&lt;p&gt;These topic sections also enable linking to there, from a summary navigation menu.&lt;/p&gt;</comment>
                                                            <comment id="192182" author="61cd0ca0bce5e00069e98be7" created="Mon, 26 Jun 2017 02:16:41 +0000"  >&lt;p&gt;Method:&lt;br/&gt;
Think of a need for a doc. Try to add it to relevant sections. If not, then add it to &quot;Others&quot;. Later make new sections. If needed, rename others.&lt;/p&gt;</comment>
                                                            <comment id="192183" author="5af5ea1ed95cfc55bfb76c8d" created="Wed, 23 Aug 2017 20:05:54 +0000"  >&lt;p&gt;Investigating a custom jekyll theme that incorporates both the common nav bar in 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-714&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-714&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Utilise the FOLIO Common Top Navigation Bar for dev.f.o&quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium&quot; /&gt;
            FOLIO-714
        &lt;/a&gt;
                                                    &lt;span class=&quot;aui-lozenge aui-lozenge-subtle aui-lozenge-success jira-macro-single-issue-export-pdf&quot;&gt;Closed&lt;/span&gt;
            &lt;/span&gt;
  and a developer navigation bar.&lt;/p&gt;</comment>
                                                            <comment id="192184" author="61cd0ca0bce5e00069e98be7" created="Tue, 12 Dec 2017 13:08:47 +0000"  >&lt;p&gt;It is difficult to resolve this via Jira, but lets try here first. Then perhaps a Zoom discussion could finalise it.&lt;/p&gt;

&lt;p&gt;Soon i will attempt to describe what we currently have, both in master and in the current PoC branch.&lt;br/&gt;
List the current set of documents.&lt;/p&gt;

&lt;p&gt;Then we could define the purpose and structure of about seven or eight top-level directories.&lt;/p&gt;

&lt;p&gt;See where those current documents fit into that, and try to anticipate some future ones.&lt;/p&gt;

&lt;p&gt;Rearrangement of docs is disruptive. It would be good to only do it once.&lt;/p&gt;</comment>
                                                            <comment id="192185" author="61cd0ca0bce5e00069e98be7" created="Tue, 12 Dec 2017 13:09:41 +0000"  >&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5af5ea1ed95cfc55bfb76c8d&quot; class=&quot;user-hover&quot; rel=&quot;5af5ea1ed95cfc55bfb76c8d&quot; data-account-id=&quot;5af5ea1ed95cfc55bfb76c8d&quot; accountid=&quot;5af5ea1ed95cfc55bfb76c8d&quot; rel=&quot;noreferrer&quot;&gt;Patricia DeStefano&lt;/a&gt; would you please say what you see as the difference between &quot;guidelines&quot; and &quot;guides&quot;.&lt;/p&gt;

&lt;p&gt;Also i am wondering if the &quot;devtools&quot; stuff might be able to go into those areas.&lt;/p&gt;</comment>
                                                            <comment id="192186" author="5af5ea1ed95cfc55bfb76c8d" created="Tue, 12 Dec 2017 20:55:54 +0000"  >&lt;p&gt;Guides - discuss key topics and concepts&lt;br/&gt;
Tutorials - process step by step&lt;br/&gt;
Guidelines - rules to follow&lt;/p&gt;

&lt;p&gt;The content files in the POC are divided into directories according to what type of content it is.  So, in the POC, right now we have 8 categories for the documents - Getting Started, Reference, Code, Guides, Download, Tutorials, Tools and Guidelines.  Each category has a corresponding directory in the POC - _guidelines, _reference&#8230;etc  So, all markdown/content files for each type of content would go in the proper directory and appear in the generated website in the corresponding section. &lt;/p&gt;

&lt;p&gt;There is a category in the POC call Tools.  If you are speaking of what I am thinking about, I would put devtools in Tools.&lt;/p&gt;</comment>
                                                            <comment id="192187" author="61cd0ca0bce5e00069e98be7" created="Thu, 14 Dec 2017 06:24:17 +0000"  >&lt;p&gt;Actually, i was wondering if we could dispense with the &quot;devtools&quot;. Those docs may be just another type of &quot;guide&quot;.&lt;/p&gt;

&lt;p&gt;There is a comment in 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-817&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-817&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Investigate another jekyll theme&quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium&quot; /&gt;
            FOLIO-817
        &lt;/a&gt;
                                                    &lt;span class=&quot;aui-lozenge aui-lozenge-subtle aui-lozenge-success jira-macro-single-issue-export-pdf&quot;&gt;Closed&lt;/span&gt;
            &lt;/span&gt;
 about perhaps being too many top nav sections.&lt;/p&gt;</comment>
                                                            <comment id="192188" author="61cd0ca0bce5e00069e98be7" created="Thu, 14 Dec 2017 06:25:17 +0000"  >&lt;p&gt;On the other hand there are some existing documents (e.g. &quot;/community/cla-process&quot; and &quot;/about/thanks&quot; and others) that might not fit into the &quot;guidelines&quot; or &quot;guides&quot; structure. Also i reckon that we will need various separate &quot;troubleshooting&quot; and &quot;faq&quot; type of documents.&lt;/p&gt;</comment>
                                                            <comment id="192189" author="61cd0ca0bce5e00069e98be7" created="Thu, 14 Dec 2017 06:26:04 +0000"  >&lt;p&gt;It would be good to have readable and consistent URLs (e.g. &quot;primer-develop-backend&quot;) i.e. using dash &quot;-&quot; between words. Rather than for example &quot;tutorials/clonebuildexploreokapi&quot;.&lt;/p&gt;

&lt;p&gt;Perhaps better to have &quot;/guides/&quot; rather than &quot;/devguides/&quot;. The whole site is about &quot;dev&quot; so that seems superfluous.&lt;/p&gt;</comment>
                                                            <comment id="192190" author="61cd0ca0bce5e00069e98be7" created="Thu, 14 Dec 2017 06:26:46 +0000"  >&lt;p&gt;I expect that we will have multiple &quot;tutorials&quot;. Would they have separate sub-directories, e.g. &quot;/tutorials/curriculum/lesson-1/&quot; and &quot;/tutorials/curriculum/lesson-2/&quot; and then another at &quot;/tutorials/another-topic/lesson-1/&quot; etc.&lt;/p&gt;</comment>
                                                            <comment id="192191" author="61cd0ca0bce5e00069e98be7" created="Thu, 14 Dec 2017 06:29:57 +0000"  >&lt;p&gt;We will being having lots of &quot;guides&quot;. The current &lt;a href=&quot;http://dev.folio.org/doc/#guides&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;dev.folio.org/doc/#guides&lt;/a&gt; makes an attempt to group guides and other documents into a set of &quot;topic groups&quot;. Can you see another way to have a &quot;guide to guides&quot;?&lt;/p&gt;</comment>
                                                            <comment id="192192" author="61cd0ca0bce5e00069e98be7" created="Mon, 18 Dec 2017 20:00:25 +0000"  >&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=5af5ea1ed95cfc55bfb76c8d&quot; class=&quot;user-hover&quot; rel=&quot;5af5ea1ed95cfc55bfb76c8d&quot; data-account-id=&quot;5af5ea1ed95cfc55bfb76c8d&quot; accountid=&quot;5af5ea1ed95cfc55bfb76c8d&quot; rel=&quot;noreferrer&quot;&gt;Patricia DeStefano&lt;/a&gt;, and others, are we able to resolve the abovementntioned comments?&lt;/p&gt;</comment>
                                                            <comment id="192193" author="5af5ea1ed95cfc55bfb76c8d" created="Mon, 18 Dec 2017 20:18:29 +0000"  >&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/secure/ViewProfile.jspa?accountId=61cd0ca0bce5e00069e98be7&quot; class=&quot;user-hover&quot; rel=&quot;61cd0ca0bce5e00069e98be7&quot; data-account-id=&quot;61cd0ca0bce5e00069e98be7&quot; accountid=&quot;61cd0ca0bce5e00069e98be7&quot; rel=&quot;noreferrer&quot;&gt;David Crossley&lt;/a&gt; A basic structure (tutorials, guides, etc) is in the POC and I am working to add the additional left hand navigation of that structure into the theme POC.  We can definitely fine tune directory names, sections and which docs are in each section.  The theme makes shuffling things and renaming fairly easy.  &lt;/p&gt;</comment>
                                                            <comment id="192194" author="61cd0ca0bce5e00069e98be7" created="Tue, 19 Dec 2017 02:30:06 +0000"  >&lt;p&gt;We need to resolve various stuff related to the actual re-arrangement of the documents. Trying to think about this early. Also some items might have impact for either theme (e.g. the questions above about sub-directories of &quot;tutorials&quot; and &quot;guides&quot;).&lt;/p&gt;</comment>
                                                            <comment id="192195" author="61cd0ca0bce5e00069e98be7" created="Wed, 17 Jan 2018 06:25:37 +0000"  >&lt;p&gt;See a demonstration of &quot;separate tutorials in sub-directories&quot; at 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-978&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-978&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Investigate solutions for page table-of-contents for dev.f.o&quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium&quot; /&gt;
            FOLIO-978
        &lt;/a&gt;
                                                    &lt;span class=&quot;aui-lozenge aui-lozenge-subtle aui-lozenge-success jira-macro-single-issue-export-pdf&quot;&gt;Closed&lt;/span&gt;
            &lt;/span&gt;
.&lt;/p&gt;</comment>
                                                            <comment id="192196" author="61cd0ca0bce5e00069e98be7" created="Wed, 4 Apr 2018 01:53:37 +0000"  >&lt;p&gt;This re-arrangment is now done. See the notes in 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-646&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-646&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Implement improved navigation dev.f.o phase 2&quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium&quot; /&gt;
            FOLIO-646
        &lt;/a&gt;
                                                    &lt;span class=&quot;aui-lozenge aui-lozenge-subtle aui-lozenge-success jira-macro-single-issue-export-pdf&quot;&gt;Closed&lt;/span&gt;
            &lt;/span&gt;
.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="80251">FOLIO-646</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="80248">FOLIO-643</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|hzxoo7:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10020" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10024" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>[CHART] Date of First Response</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Wed, 23 Aug 2017 20:05:54 +0000</customfieldvalue>

                        </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>