You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@edgent.apache.org by "Queenie Ma (JIRA)" <ji...@apache.org> on 2016/04/07 02:45:25 UTC
[jira] [Commented] (QUARKS-104) Documentation website consistency
improvements
[ https://issues.apache.org/jira/browse/QUARKS-104?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15229434#comment-15229434 ]
Queenie Ma commented on QUARKS-104:
-----------------------------------
Any thoughts on these suggestions? If there are no objections, I will go ahead and make the changes.
> Documentation website consistency improvements
> ----------------------------------------------
>
> Key: QUARKS-104
> URL: https://issues.apache.org/jira/browse/QUARKS-104
> Project: Quarks
> Issue Type: Improvement
> Components: Web Site
> Reporter: Queenie Ma
> Priority: Minor
>
> Some parts of the documentation site are inconsistent with each other, such as capitalization and differences between the sidebar titles and page titles.
> Possible improvements:
> # Remove the numbering of subsections (i.e., "Get Started", "Sample Programs", "Using The Console")
> # Commit to using title case capitalization (i.e., all words capitalized, except for minor words such as 'the', 'of', 'to', etc.) for sidebar/page titles and sentence case capitalization (i.e., first word capitalized) for page headers
> # Redundant headers should be removed (e.g., see [Common Quarks Operations|http://quarks.incubator.apache.org/docs/common-quarks-operations.html])
> # Page headers should start at level 2 using ## in order to have them added to the Table of Contents.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
Re: [jira] [Commented] (QUARKS-104) Documentation website consistency improvements
Posted by Kathy Saunders <os...@gmail.com>.
> >
> > Some parts of the documentation site are inconsistent with each other,
> such as capitalization and differences between the sidebar titles and page
> titles.
> > Possible improvements:
> > # Remove the numbering of subsections (i.e., "Get Started", "Sample
> Programs", "Using The Console")
> > # Commit to using title case capitalization (i.e., all words
> capitalized, except for minor words such as 'the', 'of', 'to', etc.) for
> sidebar/page titles and sentence case capitalization (i.e., first word
> capitalized) for page headers
> > # Redundant headers should be removed (e.g., see [Common Quarks
> Operations|
> http://quarks.incubator.apache.org/docs/common-quarks-operations.html])
> > # Page headers should start at level 2 using ## in order to have
> them added to the Table of Contents
>
> +1 These sound like good changes to me.