harmony-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Morozova, Nadezhda" <nadezhda.moroz...@intel.com>
Subject RE: [doc][user experience] simple navigation on the web site
Date Fri, 01 Dec 2006 08:28:09 GMT
Hi,
Suggested are a few tricks to improve navigation on the website, thanks
(see answers below). 

More responses are welcome. Do you, your relatives or friends have ideas
on improving our site? I remember Egor asked his Dad to surf and Geir
had a cool Granny knitting the GC<>JIT sweater...

>* It's ok to keep references at the first page.
I think we can edit the frontpage slightly to make more important staff
stand out. I mean, I get lost each time I visit the front page! 

>* Let's add build instruction to the documentation map.
You mean links to the instructions, right? Great idea, but I'd rather be
more radical with it. The current page Documentation is hardly useful.
What do you think of replacing it with some sort of Site Map with links
to all sources of resources we have?

>* Let's add build instruction to "Get involved".
Ok

>* Let's remove "Source code" section at all or replace it with a
>reference to ViewSvn.
I'd not hurry to do that. I like the Source Code page as is because it
explains different ways of accessing the source code, not just viewsvn.
However, making the viewsvn link more prominent does make sense to me.


Cheers, 
Nadya
 

>-----Original Message-----
>From: Alexei Fedotov [mailto:alexei.fedotov@gmail.com]
>Sent: Friday, December 01, 2006 1:14 AM
>To: dev@harmony.apache.org
>Subject: [doc][user experience] simple navigation on the web site Was:
svn
>commit: r480884 - in /harmony/standard/site: docs/downloads.html
>docs/quickhelp_users.html xdocs/downloads.xml xdocs/quickhelp_users.xml
>
>Nadya,
>
>Due to resource location changes my hand-made scripts stopped to work:
>all security tests failed with "*** implementation not found". I
>decided to get used to Geir's federated build.
>
>I tried to find quickly quickhelp_contributors.html serfing our web
>site. I stopped reading the first page right after the words: "Big
>News: Apache Harmony is a top-level project of the Apache Software
>Foundation! See below for more information."
>
>After visiting "Documentation", "Get Involved", "Source Code",
>"DRLVM", "Contribution Policy" sections I used search in my mailbox
>and found that you added this reference to "Downloads" section. This
>is a good location, but it didn't yet appeared at the actual web site.
>
>I decided to download the web site and use search.
>
>$ grep -rl quickhelp_contributors
>harmony.apache.org/harmony.apache.org/index.html
>harmony.apache.org/quickhelp_users.html
>harmony.apache.org/subcomponents/buildtest/index.html
>harmony.apache.org/subcomponents/classlibrary/index.html
>
>There are plenty of places, though I missed them. I believe we need do
>the following:
>* It's ok to keep references at the first page.
>* Let's add build instruction to the documentation map.
>* Let's add build instruction to "Get involved".
>* Let's remove "Source code" section at all or replace it with a
>reference to ViewSvn.
>
>What do u think?
>
>With best regards,
>Alexei
>
>On 11/30/06, nadinem@apache.org <nadinem@apache.org> wrote:
>> Author: nadinem
>> Date: Thu Nov 30 02:11:14 2006
>> New Revision: 480884
>>
>> URL: http://svn.apache.org/viewvc?view=rev&revH0884
>> Log:
>> Resolve HARMONY-1730: applied patches downloads.patch;
>quickhelp_users.patch
>>
>> Modified:
>>    harmony/standard/site/docs/downloads.html
>>    harmony/standard/site/docs/quickhelp_users.html
>>    harmony/standard/site/xdocs/downloads.xml
>>    harmony/standard/site/xdocs/quickhelp_users.xml
>>
>> Modified: harmony/standard/site/docs/downloads.html
>> URL:
>http://svn.apache.org/viewvc/harmony/standard/site/docs/downloads.html?
view
>=diff&revH0884&r1H0883&r2H0884
>>
>=======================================================================
====
>==
>> --- harmony/standard/site/docs/downloads.html (original)
>> +++ harmony/standard/site/docs/downloads.html Thu Nov 30 02:11:14
2006
>> @@ -214,13 +214,17 @@
>>                                 <p>
>>                Access to <a href="svn.html">the code repository</a>
is
>available to all, and we have
>>                <a
>href="documentation/documentation.html">instructions</a> for building
the
>> -               virtual machine code and <a
>href="documentation/build_classlib.html">
>> -               building the class library code</a>.
>> -       </p>
>> +               virtual machine code. For information on how to get
>configured to build and
>> +    work with the Apache Harmony source code, refer to
>> +    <a
>href="http://incubator.apache.org/harmony/quickhelp_contributors.html">
>> +      Getting Started For Contributors</a>. For instructions on how
to
>point to local
>> +    versions instead of making the build download new ones from the
net,
>refer to the
>> +    <a
>href="http://svn.apache.org/viewvc/incubator/harmony/enhanced/drlvm/tru
nk/R
>EADME.txt?view=co">
>> +      README file</a>.
>> +  </p>
>>                                 <p>
>> -        However, if you don't want to build it, we now offer
snapshots
>of our JRE and
>> -        <a href="subcomponents/classlibrary/hdk.html">HDK</a>
>> -        for Linux and Windows x86-based platforms.
>> +        However, if you don not want to build it, we now offer
snapshots
>of our JRE and HDK
>> +        for the Linux and Windows platforms.
>>     </p>
>>
>>     <h2>
>>
>> Modified: harmony/standard/site/docs/quickhelp_users.html
>> URL:
>http://svn.apache.org/viewvc/harmony/standard/site/docs/quickhelp_users
.htm
>l?view=diff&revH0884&r1H0883&r2H0884
>>
>=======================================================================
====
>==
>> --- harmony/standard/site/docs/quickhelp_users.html (original)
>> +++ harmony/standard/site/docs/quickhelp_users.html Thu Nov 30
02:11:14
>2006
>> @@ -229,7 +229,7 @@
>>     </h2>
>>
>>                         <p>
>> -            First of all, download the binary distribution
appropriate
>to
>> +            First, download the binary distribution appropriate to
>>             your platform. We currently distribute binaries for Linux
and
>>             Microsoft Windows. Please follow the instructions on the
>>             <a href="downloads.html">download page</a>
>> @@ -248,10 +248,10 @@
>>     </h2>
>>
>>                         <p>
>> -            Once you have obtained the appropriate binary
distribution,
>> -            you need to unpack it on your machine. In all cases, the
>> +            Once you have obtained the appropriate binary
distribution,
>> +            you need to unpack it on your machine. In all cases, the
>>             distribution will unpack into a <code>jre</code>
>> -            directory. Further in the document we refer to this
>directory
>> +            directory. Further in the document we refer to this
>directory
>>             as the <i>root directory</i> of the distribution.
>>         </p>
>>                                 <strong>Linux Users</strong>
>> @@ -266,19 +266,19 @@
>>         </p>
>>                                 <strong>Windows Users</strong>
>>                                 <p>
>> -          Use one of <code>zip</code> utilities available for
Windows to
>> -          unpack the distribution. The three popular ones are listed
>> -          below, but anything that can handle a <code>zip</code>
file
>> +          Use one of <code>zip</code> utilities available for
Windows to
>> +          unpack the distribution. The three popular ones are listed
>> +          below, but anything that can handle a <code>zip</code>
file
>>           will work:
>>         </p>
>>                                 <ul>
>> -            <li><a href="http://www.info-zip.org/">Info-ZIP</a>
>> +            <li><a href="http://www.info-zip.org/">Info-ZIP</a>
>>                 (open source software)</li>
>>             <li><a href="http://www.7-zip.org/">7-Zip</a> (free
>software)</li>
>>             <li><a href="http://www.winzip.com/">Winzip</a>
>(commercial)</li>
>>         </ul>
>>                                 <p>
>> -            To create the JRE directory tree, extract the
>> +            To create the JRE directory tree, extract the
>>             distribution <code>zip</code> file using the utility.
>>         </p>
>>
>> @@ -288,13 +288,13 @@
>>     </h2>
>>
>>                         <p>
>> -            Apache Harmony requires no further environmental setup,
but
>> -            sometimes other programs do. Also, it is convenient to
have
>> +            Apache Harmony requires no further environmental setup,
but
>> +            sometimes other programs do. Also, it is convenient to
have
>>             the Apache Harmony executables on your path.
>>         </p>
>>                                 <p>
>> -          To set your <code>JAVA_HOME</code> and <code>PATH</code>
>> -          environment variables, use the commands appropriate to
your
>> +          To set your <code>JAVA_HOME</code> and <code>PATH</code>
>> +          environment variables, use the commands appropriate to
your
>>           operating system and/or shell you are using.
>>         </p>
>>                                 <strong>
>> @@ -309,11 +309,11 @@
>>  $ export PATH=`pwd`:$PATH
>>         </pre>
>>                                 <p>
>> -            The given command assumes your current directory is the
>parent
>> -            directory of the Harmony JRE.
>> +            The given command assumes your current directory is the
>parent
>> +            directory of the Harmony JRE.
>>         </p>
>>                                 <p class="note">Note</p>
>> -                                <p class="notetext">The
<code>`</code>
>character is a backtick character,
>> +                                <p class="notetext">The
<code>`</code>
>character is a backtick character,
>>       not an apostrophe.</p>
>>                                 <strong>Windows Users</strong>
>>                                 <p>
>> @@ -334,9 +334,9 @@
>>     </h2>
>>
>>                         <p>
>> -            After performing aforementioned steps, you should be
ready
>to use
>> +            After performing aforementioned steps, you should be
ready
>to use
>>             Apache Harmony. Note that we have not yet included
>> -            <code>javac</code>, so continue to use the compiler from
>some
>> +            <code>javac</code>, so continue to use the compiler from
>some
>>             other JRE. You should have no problems running programs.
>>         </p>
>>                                 <pre>
>>
>> Modified: harmony/standard/site/xdocs/downloads.xml
>> URL:
>http://svn.apache.org/viewvc/harmony/standard/site/xdocs/downloads.xml?
view
>=diff&revH0884&r1H0883&r2H0884
>>
>=======================================================================
====
>==
>> --- harmony/standard/site/xdocs/downloads.xml (original)
>> +++ harmony/standard/site/xdocs/downloads.xml Thu Nov 30 02:11:14
2006
>> @@ -34,14 +34,18 @@
>>        <p>
>>                Access to <a href="svn.html">the code repository</a>
is
>available to all, and we have
>>                <a
>href="documentation/documentation.html">instructions</a> for building
the
>> -               virtual machine code and <a
>href="documentation/build_classlib.html">
>> -               building the class library code</a>.
>> -       </p>
>> +               virtual machine code. For information on how to get
>configured to build and
>> +    work with the Apache Harmony source code, refer to
>> +    <a
>href="http://incubator.apache.org/harmony/quickhelp_contributors.html">
>> +      Getting Started For Contributors</a>. For instructions on how
to
>point to local
>> +    versions instead of making the build download new ones from the
net,
>refer to the
>> +    <a
>href="http://svn.apache.org/viewvc/incubator/harmony/enhanced/drlvm/tru
nk/R
>EADME.txt?view=co">
>> +      README file</a>.
>> +  </p>
>>
>>     <p>
>> -        However, if you don't want to build it, we now offer
snapshots
>of our JRE and
>> -        <a href="subcomponents/classlibrary/hdk.html">HDK</a>
>> -        for Linux and Windows x86-based platforms.
>> +        However, if you don not want to build it, we now offer
snapshots
>of our JRE and HDK
>> +        for the Linux and Windows platforms.
>>     </p>
>>
>>     <subsection name="Snapshot Builds">
>>
>> Modified: harmony/standard/site/xdocs/quickhelp_users.xml
>> URL:
>http://svn.apache.org/viewvc/harmony/standard/site/xdocs/quickhelp_user
s.xm
>l?view=diff&revH0884&r1H0883&r2H0884
>>
>=======================================================================
====
>==
>> --- harmony/standard/site/xdocs/quickhelp_users.xml (original)
>> +++ harmony/standard/site/xdocs/quickhelp_users.xml Thu Nov 30
02:11:14
>2006
>> @@ -48,7 +48,7 @@
>>     <subsection name="Download the Apache Harmony Snapshot">
>>
>>         <p>
>> -            First of all, download the binary distribution
appropriate
>to
>> +            First, download the binary distribution appropriate to
>>             your platform. We currently distribute binaries for Linux
and
>>             Microsoft Windows. Please follow the instructions on the
>>             <a href="downloads.html">download page</a>
>> @@ -66,10 +66,10 @@
>>     <subsection name="Unpack the Binary Distribution">
>>
>>         <p>
>> -            Once you have obtained the appropriate binary
distribution,
>> -            you need to unpack it on your machine. In all cases, the
>> +            Once you have obtained the appropriate binary
distribution,
>> +            you need to unpack it on your machine. In all cases, the
>>             distribution will unpack into a <code>jre</code>
>> -            directory. Further in the document we refer to this
>directory
>> +            directory. Further in the document we refer to this
>directory
>>             as the <i>root directory</i> of the distribution.
>>         </p>
>>
>> @@ -90,34 +90,34 @@
>>         <strong>Windows Users</strong>
>>
>>         <p>
>> -          Use one of <code>zip</code> utilities available for
Windows to
>> -          unpack the distribution. The three popular ones are listed
>> -          below, but anything that can handle a <code>zip</code>
file
>> +          Use one of <code>zip</code> utilities available for
Windows to
>> +          unpack the distribution. The three popular ones are listed
>> +          below, but anything that can handle a <code>zip</code>
file
>>           will work:
>>         </p>
>>
>>         <ul>
>> -            <li><a href="http://www.info-zip.org/">Info-ZIP</a>
>> +            <li><a href="http://www.info-zip.org/">Info-ZIP</a>
>>                 (open source software)</li>
>>             <li><a href="http://www.7-zip.org/">7-Zip</a> (free
>software)</li>
>>             <li><a href="http://www.winzip.com/">Winzip</a>
>(commercial)</li>
>>         </ul>
>>         <p>
>> -            To create the JRE directory tree, extract the
>> +            To create the JRE directory tree, extract the
>>             distribution <code>zip</code> file using the utility.
>>         </p>
>>     </subsection>
>>
>>     <subsection name="Configuring Your Environment">
>>         <p>
>> -            Apache Harmony requires no further environmental setup,
but
>> -            sometimes other programs do. Also, it is convenient to
have
>> +            Apache Harmony requires no further environmental setup,
but
>> +            sometimes other programs do. Also, it is convenient to
have
>>             the Apache Harmony executables on your path.
>>         </p>
>>
>>         <p>
>> -          To set your <code>JAVA_HOME</code> and <code>PATH</code>
>> -          environment variables, use the commands appropriate to
your
>> +          To set your <code>JAVA_HOME</code> and <code>PATH</code>
>> +          environment variables, use the commands appropriate to
your
>>           operating system and/or shell you are using.
>>         </p>
>>
>> @@ -136,11 +136,11 @@
>>         </source>
>>
>>         <p>
>> -            The given command assumes your current directory is the
>parent
>> -            directory of the Harmony JRE.
>> +            The given command assumes your current directory is the
>parent
>> +            directory of the Harmony JRE.
>>         </p>
>>       <p class="note">Note</p>
>> -      <p class="notetext">The <code>`</code> character is a backtick
>character,
>> +      <p class="notetext">The <code>`</code> character is a backtick
>character,
>>       not an apostrophe.</p>
>>
>>       <strong>Windows Users</strong>
>> @@ -164,9 +164,9 @@
>>     <subsection name="Using Apache Harmony">
>>
>>         <p>
>> -            After performing aforementioned steps, you should be
ready
>to use
>> +            After performing aforementioned steps, you should be
ready
>to use
>>             Apache Harmony. Note that we have not yet included
>> -            <code>javac</code>, so continue to use the compiler from
>some
>> +            <code>javac</code>, so continue to use the compiler from
>some
>>             other JRE. You should have no problems running programs.
>>         </p>
>>
>>
>>
>>
>
>
>--
>Thank you,
>Alexei

Mime
View raw message