Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 255356 - Update metadoc.xml with new infrastructure project documentation
Summary: Update metadoc.xml with new infrastructure project documentation
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs on www.gentoo.org
Classification: Unclassified
Component: Other documents (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Gentoo Infrastructure
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-01-18 09:01 UTC by Peter Volkov (RETIRED)
Modified: 2013-11-22 22:57 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Peter Volkov (RETIRED) gentoo-dev 2009-01-18 09:01:26 UTC
Hello.

Currently http://www.gentoo.org/doc/en/list.xml lists the following Infrastructure Project Documentation:

    * Infrastructure Project Documentation
          o Gentoo E-mail System
          o SSH access to cvs.gentoo.org
          o Gentoo Developer/Test Machines
          o Gentoo Infrastructure Server Specifications
          o Gentoo Linux Documentation -- Tenshi
          o NTP Configuration Guide for Gentoo Infrastructure Servers
          o SSH Configuration Guide for Gentoo Infrastructure Servers
          o Logging Configuration Guide for Gentoo Infrastructure Servers
          o Web Space Configuration for dev.gentoo.org
          o Gentoo Infrastructure Frequently Asked Questions
          o Instructions for administering our rsync mirror system.

While infrastructure project has different naming and some additional docs:

    *   Developer: Instructions for setting up and accessing your @gentoo.org e-mail account
    * Developer: Instructions for placing your SSH key on cvs.gentoo.org to gain CVS access
    * Developer: Instructions for using LDAP on dev.gentoo.org to search for and modify attributes
    * Developer: Machines of different architectures available for the sole purpose of Gentoo development
    * Developer: Instructions and policy for setting up dev.gentoo.org/~YourUserName
    * Servers: Specifications, including disk space, RAM and CPU for our various infrastructure servers
    * Servers: Tenshi, a custom log monitoring tool developed for Gentoo infrastructure servers
    * Infrastructure: Maintainers Guide - torrents.gentoo.org
    * Infrastructure: Process for retiring developers
    * Infrastructure: How and Why Gentoo Uses Sender Policy Framework
    * Infrastructure: Working with Sender Policy Framework
    * Infrastructure: How to filter on Reply-To
    * Infrastructure: Instructions for administering our rsync mirror system.
    * Infrastructure: SSH Configuration Guide for Gentoo Infrastructure Servers.
    * Misc: Analysis of the Nuthatch exploitation attempts


Please, update metadoc.xml. Thanks.
Comment 1 Xavier Neys (RETIRED) gentoo-dev 2009-01-18 14:32:51 UTC
http://www.gentoo.org/doc/en/index.xml?catid=project#doc_chap2_sect5

> While infrastructure project has different naming 

We do not write a single word of that list. Infra does.
All we do is maintain the list of the links themselves.
Titles & descriptions are entirely up to authors.

> and some additional docs:

Infra can ask to unlink or add documents they want to see listed in the doc index.
Comment 2 Robin Johnson archtester Gentoo Infrastructure gentoo-dev Security 2009-01-18 21:17:19 UTC
Why do we need two lists for the same set of documents?
Our titles under the resources list on the infrastructure page are because the actual document title doesn't tell you a lot, and we could explain better.

Neys: 
1. can you make the toplevel list.xml just suck the resource links from the index.xml pages?
2. also in list.xml, make headings like "Infrastructure Project Documentation" also link to the page that it takes the content from?
Comment 3 Xavier Neys (RETIRED) gentoo-dev 2009-01-18 22:39:20 UTC
> Our titles under the resources list on the infrastructure page are because the
> actual document title doesn't tell you a lot, and we could explain better.

If title & descriptions are not good enough, why don't you fix them?
<title> & <abstract> in *your* docs provide the info for the indexes.

> Neys: 
> 1. can you make the toplevel list.xml just suck the resource links from the
> index.xml pages?

No.

> 2. also in list.xml, make headings like "Infrastructure Project Documentation"
> also link to the page that it takes the content from?

No.
We don't have headings like "Infrastructure Project Documentation".
We have 1 (one) category that we labeled "Infrastructure Project Documentation" and then some docs that belong to that category. If you don't like the list we made, feel free to suggest a patch to change the list. BTW, we only have links, no title, no description, *you* the authors write those.
If you want, we can reduce that list to a single document: /proj/en/index.xml
Comment 4 nm (RETIRED) gentoo-dev 2013-11-22 22:57:15 UTC
it's dead, jim. (with the move to the wiki for project docs.)