[jira] Created: (DERBY-4236) Update the FAQ for Derby 10.5

Update the FAQ for Derby 10.5
-----------------------------

                 Key: DERBY-4236
                 URL: https://issues.apache.org/jira/browse/DERBY-4236
             Project: Derby
          Issue Type: Task
          Components: Web Site
    Affects Versions: 10.5.1.1
            Reporter: Kristian Waagan
            Priority: Minor


The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.

At least the following two entries should be updated:
 - 4.7. Does Derby have a mode that causes it to run entirely in memory?
 - 5.2. Does Derby support a LIMIT command?

We may also want to add more recent news for these:
 - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
 - 5.5. Can Derby generate unique identifiers like sequences?

Finally, a general task:
 - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?

There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/DERBY-4236?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bryan Pendleton reassigned DERBY-4236:
--------------------------------------

    Assignee: Bryan Pendleton

> Update the FAQ for Derby 10.5
> -----------------------------
>
>                 Key: DERBY-4236
>                 URL: https://issues.apache.org/jira/browse/DERBY-4236
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.5.1.1
>            Reporter: Kristian Waagan
>            Assignee: Bryan Pendleton
>            Priority: Minor
>
> The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.
> At least the following two entries should be updated:
>  - 4.7. Does Derby have a mode that causes it to run entirely in memory?
>  - 5.2. Does Derby support a LIMIT command?
> We may also want to add more recent news for these:
>  - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
>  - 5.5. Can Derby generate unique identifiers like sequences?
> Finally, a general task:
>  - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?
> There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/DERBY-4236?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bryan Pendleton updated DERBY-4236:
-----------------------------------

    Attachment: xml.diff

I updated the XML source file, and am attaching the diff.

I've never built the Derby site before, so now I'll need to learn how.

I guess the first step is to try installing Forrest and see if 'forrest site' works?

> Update the FAQ for Derby 10.5
> -----------------------------
>
>                 Key: DERBY-4236
>                 URL: https://issues.apache.org/jira/browse/DERBY-4236
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.5.1.1
>            Reporter: Kristian Waagan
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: xml.diff
>
>
> The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.
> At least the following two entries should be updated:
>  - 4.7. Does Derby have a mode that causes it to run entirely in memory?
>  - 5.2. Does Derby support a LIMIT command?
> We may also want to add more recent news for these:
>  - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
>  - 5.5. Can Derby generate unique identifiers like sequences?
> Finally, a general task:
>  - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?
> There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

    [ https://issues.apache.org/jira/browse/DERBY-4236?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12772334#action_12772334 ]

Bryan Pendleton commented on DERBY-4236:
----------------------------------------

http://db.apache.org/derby/papers/derby_web.html has instructions...

> Update the FAQ for Derby 10.5
> -----------------------------
>
>                 Key: DERBY-4236
>                 URL: https://issues.apache.org/jira/browse/DERBY-4236
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.5.1.1
>            Reporter: Kristian Waagan
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: xml.diff
>
>
> The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.
> At least the following two entries should be updated:
>  - 4.7. Does Derby have a mode that causes it to run entirely in memory?
>  - 5.2. Does Derby support a LIMIT command?
> We may also want to add more recent news for these:
>  - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
>  - 5.5. Can Derby generate unique identifiers like sequences?
> Finally, a general task:
>  - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?
> There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

    [ https://issues.apache.org/jira/browse/DERBY-4236?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12772338#action_12772338 ]

Bryan Pendleton commented on DERBY-4236:
----------------------------------------

I encountered FOR-984 because my development machine runs JDK 1.6.
Editing forrest.properties as follows seemed to work, following the suggestion
in the FOR-984 description:

-#forrest.validate.sitemap=${forrest.validate}
-#forrest.validate.stylesheets=${forrest.validate}
+forrest.validate.sitemap=false
+forrest.validate.stylesheets=false

> Update the FAQ for Derby 10.5
> -----------------------------
>
>                 Key: DERBY-4236
>                 URL: https://issues.apache.org/jira/browse/DERBY-4236
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.5.1.1
>            Reporter: Kristian Waagan
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: xml.diff
>
>
> The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.
> At least the following two entries should be updated:
>  - 4.7. Does Derby have a mode that causes it to run entirely in memory?
>  - 5.2. Does Derby support a LIMIT command?
> We may also want to add more recent news for these:
>  - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
>  - 5.5. Can Derby generate unique identifiers like sequences?
> Finally, a general task:
>  - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?
> There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/DERBY-4236?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bryan Pendleton updated DERBY-4236:
-----------------------------------

    Attachment: asBuilt.diff
                faq.html

I successfully built and tested the updated FAQ. Attached is the revised
faq.html as well as the patch-as-built, including the proposed change
to forrest.properties to work around FOR-984.

Please let me know how this looks.

> Update the FAQ for Derby 10.5
> -----------------------------
>
>                 Key: DERBY-4236
>                 URL: https://issues.apache.org/jira/browse/DERBY-4236
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.5.1.1
>            Reporter: Kristian Waagan
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: asBuilt.diff, faq.html, xml.diff
>
>
> The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.
> At least the following two entries should be updated:
>  - 4.7. Does Derby have a mode that causes it to run entirely in memory?
>  - 5.2. Does Derby support a LIMIT command?
> We may also want to add more recent news for these:
>  - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
>  - 5.5. Can Derby generate unique identifiers like sequences?
> Finally, a general task:
>  - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?
> There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

    [ https://issues.apache.org/jira/browse/DERBY-4236?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12772450#action_12772450 ]

Kristian Waagan commented on DERBY-4236:
----------------------------------------

Thanks for doing this, Bryan.

The changes look good, I only have the following comments:
 - version inconsistency under "How do I search the Derby site?" (10.2 != 10.5)
 - the attached page looks a bit different, and I assume that's because it is displayed without using any stylesheets.
 - there are several problems with links in the FAQ (not related to your changes). Unless you want to have a look at this yourself, I can have a look at it after you have committed your changes (running http://validator.w3.org/checklink is a good first step).

+1 to commit.

Regarding the disabled checks, are there configurations were they do us any good?

> Update the FAQ for Derby 10.5
> -----------------------------
>
>                 Key: DERBY-4236
>                 URL: https://issues.apache.org/jira/browse/DERBY-4236
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.5.1.1
>            Reporter: Kristian Waagan
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: asBuilt.diff, faq.html, xml.diff
>
>
> The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.
> At least the following two entries should be updated:
>  - 4.7. Does Derby have a mode that causes it to run entirely in memory?
>  - 5.2. Does Derby support a LIMIT command?
> We may also want to add more recent news for these:
>  - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
>  - 5.5. Can Derby generate unique identifiers like sequences?
> Finally, a general task:
>  - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?
> There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/DERBY-4236?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bryan Pendleton updated DERBY-4236:
-----------------------------------

    Attachment: fixSearchFAQ.diff

Thanks for catching that 10.2 reference, Kristian; I've fixed it in this latest patch.

I don't think the changes to forrest.properties loses any important functionality from Forrest; I didn't see any warnings to that effect in the FOR-984 bug report.
But I don't have a lot of experience with Forrest.

I ran the w3.org link checker, but decided not to make any additional changes
to the faq at this time. I think it would be great if you can look at some of those
link problems if you get time.

In the meantime, I intend to commit this patch, and see if I can finish following the build instructions so that these changes go live on the site.

> Update the FAQ for Derby 10.5
> -----------------------------
>
>                 Key: DERBY-4236
>                 URL: https://issues.apache.org/jira/browse/DERBY-4236
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.5.1.1
>            Reporter: Kristian Waagan
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: asBuilt.diff, faq.html, fixSearchFAQ.diff, xml.diff
>
>
> The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.
> At least the following two entries should be updated:
>  - 4.7. Does Derby have a mode that causes it to run entirely in memory?
>  - 5.2. Does Derby support a LIMIT command?
> We may also want to add more recent news for these:
>  - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
>  - 5.5. Can Derby generate unique identifiers like sequences?
> Finally, a general task:
>  - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?
> There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

    [ https://issues.apache.org/jira/browse/DERBY-4236?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12772843#action_12772843 ]

Bryan Pendleton commented on DERBY-4236:
----------------------------------------

Committed to the site trunk as revision 832277.

> Update the FAQ for Derby 10.5
> -----------------------------
>
>                 Key: DERBY-4236
>                 URL: https://issues.apache.org/jira/browse/DERBY-4236
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.5.1.1
>            Reporter: Kristian Waagan
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: asBuilt.diff, faq.html, fixSearchFAQ.diff, xml.diff
>
>
> The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.
> At least the following two entries should be updated:
>  - 4.7. Does Derby have a mode that causes it to run entirely in memory?
>  - 5.2. Does Derby support a LIMIT command?
> We may also want to add more recent news for these:
>  - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
>  - 5.5. Can Derby generate unique identifiers like sequences?
> Finally, a general task:
>  - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?
> There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

    [ https://issues.apache.org/jira/browse/DERBY-4236?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12773107#action_12773107 ]

Bryan Pendleton commented on DERBY-4236:
----------------------------------------

I signed on to people.apache.org and updated /www/db.apache.org/derby/faq.html from subversion,
but the change is not visible at http://db.apache.org/derby/faq.html.

According to http://db.apache.org/derby/papers/derby_web.html#9.+Make+web+site+changes+visible
"www.apache.org automatically syncs up with people.apache.org every couple hours"
but maybe that process is not working?

Anybody know how this process is supposed to work?

> Update the FAQ for Derby 10.5
> -----------------------------
>
>                 Key: DERBY-4236
>                 URL: https://issues.apache.org/jira/browse/DERBY-4236
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.5.1.1
>            Reporter: Kristian Waagan
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: asBuilt.diff, faq.html, fixSearchFAQ.diff, xml.diff
>
>
> The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.
> At least the following two entries should be updated:
>  - 4.7. Does Derby have a mode that causes it to run entirely in memory?
>  - 5.2. Does Derby support a LIMIT command?
> We may also want to add more recent news for these:
>  - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
>  - 5.5. Can Derby generate unique identifiers like sequences?
> Finally, a general task:
>  - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?
> There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

    [ https://issues.apache.org/jira/browse/DERBY-4236?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12773412#action_12773412 ]

Kristian Waagan commented on DERBY-4236:
----------------------------------------

Your changes are visible now, so I guess it just took a while before the sync happened.
The paper you refer to is most likely written by someone in the Derby community, whereas the sync schedule is set by the infra team. I wouldn't be surprised if the schedule changed during the last years :)

> Update the FAQ for Derby 10.5
> -----------------------------
>
>                 Key: DERBY-4236
>                 URL: https://issues.apache.org/jira/browse/DERBY-4236
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.5.1.1
>            Reporter: Kristian Waagan
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: asBuilt.diff, faq.html, fixSearchFAQ.diff, xml.diff
>
>
> The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.
> At least the following two entries should be updated:
>  - 4.7. Does Derby have a mode that causes it to run entirely in memory?
>  - 5.2. Does Derby support a LIMIT command?
> We may also want to add more recent news for these:
>  - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
>  - 5.5. Can Derby generate unique identifiers like sequences?
> Finally, a general task:
>  - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?
> There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/DERBY-4236?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bryan Pendleton resolved DERBY-4236.
------------------------------------

       Resolution: Fixed
    Fix Version/s: 10.6.0.0

Thanks Kristian! It seems that I had some sort of browser caching problem that
was clouding my mind; when I shift-reloaded the page it indeed came up with
the updated version.

> Update the FAQ for Derby 10.5
> -----------------------------
>
>                 Key: DERBY-4236
>                 URL: https://issues.apache.org/jira/browse/DERBY-4236
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.5.1.1
>            Reporter: Kristian Waagan
>            Assignee: Bryan Pendleton
>            Priority: Minor
>             Fix For: 10.6.0.0
>
>         Attachments: asBuilt.diff, faq.html, fixSearchFAQ.diff, xml.diff
>
>
> The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.
> At least the following two entries should be updated:
>  - 4.7. Does Derby have a mode that causes it to run entirely in memory?
>  - 5.2. Does Derby support a LIMIT command?
> We may also want to add more recent news for these:
>  - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
>  - 5.5. Can Derby generate unique identifiers like sequences?
> Finally, a general task:
>  - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?
> There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/DERBY-4236?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kristian Waagan closed DERBY-4236.
----------------------------------


I'm considering this issue completed. Thank you, Bryan!

> Update the FAQ for Derby 10.5
> -----------------------------
>
>                 Key: DERBY-4236
>                 URL: https://issues.apache.org/jira/browse/DERBY-4236
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.5.1.1
>            Reporter: Kristian Waagan
>            Assignee: Bryan Pendleton
>            Priority: Minor
>             Fix For: 10.6.0.0
>
>         Attachments: asBuilt.diff, faq.html, fixSearchFAQ.diff, xml.diff
>
>
> The FAQ at http://db.apache.org/derby/faq.html should be updated for Derby version 10.5.
> At least the following two entries should be updated:
>  - 4.7. Does Derby have a mode that causes it to run entirely in memory?
>  - 5.2. Does Derby support a LIMIT command?
> We may also want to add more recent news for these:
>  - 5.3. Why do I get the error 'schema does not exist'? [is this an issue still?]
>  - 5.5. Can Derby generate unique identifiers like sequences?
> Finally, a general task:
>  - Update links to the 10.2 docs to a newer revision [where appropriate], i.e. the 10.5 docs or even the trunk?
> There may be more items to fix.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.