www/server/staging gnu-website-guidelines-appen...

[Dora Scilipoti]

CVSROOT:        /web/www
Module name:    www
Changes by:     Dora Scilipoti <dora>   24/03/16 03:35:44

Modified files:
        server/staging : gnu-website-guidelines-appendix-1.html 

Log message:
        * Don't use blockquote when it's not a quotation (for indentation, use 
the 'indent-para' class instead).
        * Don't use <code> for mere reference to a webpage.
        * Comment out reference to future article whats-wrong-with-github.html.
        * Move to the previous paragraph the statement about linking to 
individual files (it applies to both of the items listed below).
          Modify the item below accordingly.
        * Move the paragraph about issue trackers (it applies to both cases 
listed above).
        * Refer to 'Graphics, documents, manuals' as resources.
        * Specify that the orgguide-es example happened in the past.

CVSWeb URLs:
http://web.cvs.savannah.gnu.org/viewcvs/www/server/staging/gnu-website-guidelines-appendix-1.html?cvsroot=www&r1=1.5&r2=1.6

Patches:
Index: gnu-website-guidelines-appendix-1.html
===================================================================
RCS file: /web/www/www/server/staging/gnu-website-guidelines-appendix-1.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- gnu-website-guidelines-appendix-1.html      12 Mar 2024 12:16:52 -0000      
1.5
+++ gnu-website-guidelines-appendix-1.html      16 Mar 2024 07:35:43 -0000      
1.6
@@ -96,9 +96,9 @@
 well-known proprietary software.  For example, the following
 text&mdash;and not much else&mdash;would be acceptable:</p>
 
-<blockquote><p>w3 is a web browser for GNU Emacs, similar to Internet 
-Explorer. It can run on all platforms GNU Emacs runs on, including 
-GNU/Linux, proprietary Unix systems, and Windows.</p></blockquote>
+<p class="indent-para">w3 is a web browser for GNU Emacs, similar to 
+Internet Explorer. It can run on all platforms GNU Emacs runs on, 
+including GNU/Linux, proprietary Unix systems, and Windows.</p>
 
 <p>Links which appear in other areas, such as the testimonials or
 philosophy pages, as well as links to user groups or third party 
@@ -122,10 +122,9 @@
 
 <p>Any exceptions to this rule should be apparent from the context. For 
 instance, user group pages or pages of organizations listed in 
-<code>/links/links.html</code> may talk in greater detail about open 
-source; we state on those pages, &ldquo;The FSF is not responsible for 
-the contents of other websites, or how up-to-date their information 
-is.&rdquo;</p>
+links.html may talk in greater detail about open source; we state on 
+those pages, &ldquo;The FSF is not responsible for the contents of other 
+websites, or how up-to-date their information is.&rdquo;</p>
 </dd>
 
 <dt>How does the page treat the GNU Project?</dt>
@@ -189,22 +188,23 @@
 href="https://codeberg.org/gothub/gothub";>GotHub</a>&mdash;a free 
 software frontend for GitHub that works without JavaScript&mdash;to 
 replace links to pages and resources hosted at GitHub, a website that 
-requires running nonfree JavaScript to be usable as intended. (See all
-reasons why [link to future article 'whats-wrong-with-github.html' the 
-GNU Project does not recommend GitHub].)</p> 
+requires running nonfree JavaScript to be usable as intended. 
+<!-- Add link to future article as follows: (See also 
+<a href="/DIR/whats-wrong-with-github.html">What's Wrong with GitHub</a>.)--> 
+</p>
 
 <p>Currently (March 2024), GotHub is not actively maintained and it 
 lacks some functionalities. For example, it doesn't offer a way to 
 browse repositories or download the source code without visiting the 
 GitHub website, and it doesn't provide a git clone URL. Still, GotHub is 
-helpful for some usages.</p>
+helpful for some usages. For example, GotHub works well for linking to 
+individual files.</p>
 
-<p><strong>* Software packages</strong>. GotHub works well for linking 
-to individual files. A useful one for software projects is the README
-file; it contains a description of the package, which is usually the 
-first thing a user wants to see before attempting to fetch the 
-repository. We have applied this solution several times in www.gnu.org; 
-for example, we replaced this:<br />
+<p><strong>* Software packages</strong>. A useful file for software 
+projects is the README file; it contains a description of the package, 
+which is usually the first thing a user wants to see before attempting 
+to fetch the repository. We have applied this solution several times in 
+www.gnu.org; for example, we replaced this:<br />
 <span 
class="bad"><code><del>https://github.com/pbatard/rufus</del></code></span> <br 
/>
 with this: <br />
 <span 
class="good"><code>https://gothub.frontendfriendly.xyz/pbatard/rufus/blob/master/README.md</code></span>.</p>
@@ -213,19 +213,11 @@
 commit on GitHub. The drawback of this method is that it is not very 
 useful for tracking the project over time.</p>
 
-<p>Issue trackers on GitHub can be viewed and browsed without 
-JavaScript, but active participation entails an account that can't be 
-created without running nonfree JavaScript. It's okay to link to closed 
-issues, like we did for <br />
-<span 
class="good"><code>https://github.com/w3c/fingerprinting-guidance/issues/8</code></span>.
 <br />
-Another possibility for closed issues is to link to the archived page at
-the Wayback Machine.</p>     
-
-<p><strong>* Graphics, documents, manuals</strong>. These are sometimes 
-hosted in user pages that do not require JavaScript to be fully usable, 
-even when they are hosted inside an area of the GitHub website. In these 
-cases, it is okay to link to such pages. For example, we replaced a link 
-to <br />
+<p><strong>* Graphics, documents, manuals</strong>. These resources are 
+sometimes hosted in user pages that do not require JavaScript to be 
+fully usable, even when they are hosted inside an area of the GitHub 
+website. In these cases, it is okay to link to such pages. For example, 
+we replaced a link to <br />
 <span 
class="bad"><code><del>https://github.com/foocorp/gnu-fm/blob/main/clients/meego/librefm/src/librefm-logo.png</del></code></span><br
 />
 with a link to <br />
 <span 
class="good"><code>https://raw.githubusercontent.com/foocorp/gnu-fm/main/clients/meego/librefm/src/librefm-logo.png</code>
@@ -234,15 +226,15 @@
 <span 
class="good"><code>https://raw.githubusercontent.com/scootergrisen/licenser/master/gpl-3.0.da.txt</code></span>.
 </p>
 
-<p>Sometimes a document may be hosted in more than one acceptable place. 
-It can be a personal page at GitHub, somewhere else, or at some 
+<p>Sometimes a resource may be hosted in more than one acceptable place. 
+It can be a personal page at GitHub or somewhere else, or in some 
 unrelated website. When evaluating which one to choose, consider factors
 such as: What's the status of the document? Is it a final version or is 
 it likely to be modified anytime soon? Is the URL reliably stable, or 
 is it likely to be moved?</p> 
 
-<p>For example, we had the case of a manual that was listed in 
-other-free-books.html with this URL:<br />
+<p>For example, in the past we had the case of a manual that was listed 
+in other-free-books.html with this URL:<br />
 <span 
class="bad"><code><del>https://github.com/davidam/orgguide-es</del></code></span>.<br
 />
 We had three possibilitites to replace that bad link: <br />
 1. GotHub<br />
@@ -255,9 +247,15 @@
 We decided for the third one, since it doesn't seem that the manual is
 likely to be updated to a new version, and <cite>Traficantes de Sueños</cite>
 is an established, well-known editor.</p>
-</dd>
 
-<dd>
+<p>Issue trackers on GitHub can be viewed and browsed without JavaScript, 
+but active participation entails an account that can't be created without 
+running nonfree JavaScript. It's okay to link to closed issues, like we 
+did for <br />
+<span 
class="good"><code>https://github.com/w3c/fingerprinting-guidance/issues/8</code></span>.
 <br />
+Another possibility for closed issues is to link to the archived page at
+the Wayback Machine.</p> 
+
 <p>Lastly, consider the possibility of talking to maintainers and 
 authors to explain the problem. Hopefully they will move the repo 
 somewhere else or post the material in a place we can link to.</p>
@@ -326,7 +324,7 @@
 
 <p class="unprintable">Updated:
 <!-- timestamp start -->
-$Date: 2024/03/12 12:16:52 $
+$Date: 2024/03/16 07:35:43 $
 <!-- timestamp end --></p>
 </div>
 </div><!-- for class="inner", starts in the banner include -->