Annotation of wikisrc/htdocs_migration.mdwn, revision 1.4

1.1       jdf         1: # Migraton from htdocs to the wiki
                      2: There are several reasons people want away from the current htdocs system. 
                      3: The main part is that its structure made in docbook is difficult to maintain, 
                      4: and user contributions are nearly impossible.
                      5: Thus, the plan is to migrate the website to the wiki, from docbook to markdown.
                      6: This cannot be done automatically, the sites have to be reviewed before entering
                      7: them in markdown, and the links have to be corrected.
                      8: 
                      9: If you want to participate, just have a look at the not-yet transformed articles
                     10: and transfer them. If you need access to a working wiki, write a mail to jdf@ 
                     11: with your mail-address and username and you will be granted access to the GCi 
                     12: wiki.
                     13: 
                     14: ## How htdocs is organized
                     15: You can check out the current htdocs tree with CVS from any NetBSD CVS server 
                     16: just by checking out `htdocs`.
                     17: 
                     18: There are 187 `index.html` in the current htdocs, which means there are 187 
                     19: primary topics with subpages.
                     20: 
                     21: ## Migration plan
                     22: The current plan is just to move the files to markdown and the wiki, and then 
                     23: link on the website via .htaccess to the new wiki articles.
                     24: The old website should then be statically available at some location.
                     25: 
                     26: It's still questionable whether the whole website has to be transferred 
                     27: one-to-one, or whether we should take the chance to review all the content, 
                     28: which might take up very long and is not possible without further coordination 
                     29: of all developers, esp. for the port maintainers.
                     30: 
                     31: The articles which clearly have to be transferred are the ones in the `/docs` 
                     32: and the `/ports` hierarchy. For the other ones, as well as the dynamically 
                     33: generated content like the `/changes`, special care has to be taken whether they 
                     34: should be migrated and if so, the generating scripts have to be modified.
                     35: 
                     36: The files in the `/images` subdirectory should be uploaded again, but their 
                     37: usage has to be looked up.
1.3       wiki       38: ## Semantical structure of the website
                     39: As a wiki is potentially unordered while the website had a semantical structure,
                     40: we need a structure also on the wiki. When migrating anyway, this would have to
                     41: be reviewed.
                     42: Current website structure:
                     43: 
                     44:  * about
                     45:  * changes (automatically generated)
                     46:  * community (only external links)
                     47:  * contrib
                     48:      * Organizations that contributed to NetBSD
                     49:  * developers
                     50:      * cvs-repos
                     51:      * features
                     52:      * pkgsrc
                     53:      * releng
                     54:  * docs
                     55:      * Hardware
                     56:          * Busses
                     57:      * Chips
                     58:      * Machines
                     59:      * Misc
                     60:      * psd, smm, usd
                     61:      * Guide
                     62:          * Installation guide
                     63:          * Diverse information
                     64:      * Internals guide
                     65:      * Kernel
                     66:      * misc
                     67:         * smbprint
                     68:      * network
                     69:      * ipsec
                     70:      * ipv6
                     71:      * isdn
                     72:      * netboot
                     73:      * nsps
                     74:      * pppoe
                     75:      * pkgsrc Guide
                     76:      * puffs
                     77:      * rump
                     78:      * research
                     79:      * power-mgmt
                     80:      * software
                     81:  * foundation
                     82:      * press
                     83:      * reports
                     84:          * financial
                     85:      * resolutions
                     86:  * gallery
                     87:      * advocacy
                     88:          * flyer
                     89:      * sschumacher flyer
                     90:      * events
                     91:      * in-Action
                     92:      * presentations
                     93:      * press
                     94:      * xplanet
                     95:  * mirrors
                     96:  * mailinglists
                     97:  * people
                     98:      * groups
                     99:  * ports
                    100:      * diverse ports
                    101:  * releases
                    102:      * diverse releases
                    103:  * releng
                    104:  * support
                    105:      * hardware
                    106:      * security
1.1       jdf       107: 
                    108: ## To be done
                    109: Those which are not yet transformed are these:
1.2       jdf       110: 
1.1       jdf       111:     ./index.html
                    112:     ./about/index.html
                    113:     ./changes/index.html
                    114:     ./community/index.html
                    115:     ./contrib/org/index.html
                    116:     ./contrib/index.html
                    117:     ./developers/index.html
                    118:     ./developers/cvs-repos/index.html
                    119:     ./developers/features/index.html
                    120:     ./developers/pkgsrc/index.html
                    121:     ./developers/releng/index.html
                    122:     ./docs/Hardware/Busses/ADB/index.html
                    123:     ./docs/Hardware/Busses/ATA/index.html
                    124:     ./docs/Hardware/Busses/index.html
                    125:     ./docs/Hardware/Busses/I2C/index.html
                    126:     ./docs/Hardware/Busses/IEEE1394/index.html
                    127:     ./docs/Hardware/Busses/MCA/index.html
                    128:     ./docs/Hardware/Busses/Q-bus/index.html
                    129:     ./docs/Hardware/Busses/SCSI/index.html
                    130:     ./docs/Hardware/Busses/USB/index.html
                    131:     ./docs/Hardware/Busses/VME/index.html
                    132:     ./docs/Hardware/Busses/Zorro/index.html
                    133:     ./docs/Hardware/index.html
                    134:     ./docs/Hardware/Chips/DEC/index.html
                    135:     ./docs/Hardware/Chips/index.html
                    136:     ./docs/Hardware/Chips/HP/index.html
                    137:     ./docs/Hardware/Chips/Intel/index.html
                    138:     ./docs/Hardware/Chips/MIPS/index.html
                    139:     ./docs/Hardware/Chips/Microchip/index.html
                    140:     ./docs/Hardware/Chips/Motorola/index.html
                    141:     ./docs/Hardware/Chips/NatSemi/index.html
                    142:     ./docs/Hardware/Chips/TI/index.html
                    143:     ./docs/Hardware/Machines/ARC/index.html
                    144:     ./docs/Hardware/Machines/DEC/vax/index.html
                    145:     ./docs/Hardware/Machines/DEC/index.html
                    146:     ./docs/Hardware/Machines/index.html
                    147:     ./docs/Hardware/Machines/Apollo/index.html
                    148:     ./docs/Hardware/Machines/Apple/index.html
                    149:     ./docs/Hardware/Machines/Commodore/index.html
                    150:     ./docs/Hardware/Machines/HP/index.html
                    151:     ./docs/Hardware/Machines/IBM/index.html
                    152:     ./docs/Hardware/Machines/MacroSystem/index.html
                    153:     ./docs/Hardware/Machines/Motorola/index.html
                    154:     ./docs/Hardware/Machines/NeXT/index.html
                    155:     ./docs/Hardware/Machines/PC532/index.html
                    156:     ./docs/Hardware/Machines/Sun/index.html
                    157:     ./docs/Hardware/Misc/index.html
                    158:     ./docs/index.html
                    159:     ./docs/bsd/lite2/index.html
                    160:     ./docs/bsd/index.html
                    161:     ./docs/bsd/net2/index.html
                    162:     ./docs/cross/index.html
                    163:     ./docs/kernel/profiling/index.html
                    164:     ./docs/kernel/index.html
                    165:     ./docs/kernel/pseudo/index.html
                    166:     ./docs/misc/smbprint/index.html
                    167:     ./docs/network/ipsec/index.html
                    168:     ./docs/network/ipv6/index.html
                    169:     ./docs/network/isdn/index.html
                    170:     ./docs/network/netboot/rbootd/index.html
                    171:     ./docs/network/netboot/index.html
                    172:     ./docs/network/pppoe/index.html
                    173:     ./docs/pkgsrc/index.html
                    174:     ./docs/power-mgmt/index.html
                    175:     ./docs/research/index.html
                    176:     ./docs/rump/index.html
                    177:     ./docs/software/index.html
                    178:     ./donations/index.html
                    179:     ./errors/index.html
                    180:     ./foundation/index.html
                    181:     ./foundation/press/index.html
                    182:     ./gallery/advocacy/index.html
                    183:     ./gallery/index.html
                    184:     ./gallery/events/usenix2001/index.html
                    185:     ./gallery/events/index.html
                    186:     ./gallery/events/usenix2002/index.html
                    187:     ./gallery/events/usenix2003/index.html
                    188:     ./gallery/events/usenix2004/index.html
                    189:     ./gallery/in-Action/index.html
                    190:     ./gallery/presentations/index.html
                    191:     ./gallery/xplanet/index.html
                    192:     ./mailinglists/index.html
                    193:     ./mirrors/torrents/index.html
                    194:     ./mirrors/index.html
                    195:     ./people/index.html
                    196:     ./people/groups/index.html
                    197:     ./ports/acorn26/index.html
                    198:     ./ports/acorn32/index.html
                    199:     ./ports/algor/index.html
                    200:     ./ports/alpha/index.html
                    201:     ./ports/amiga/index.html
                    202:     ./ports/amigappc/index.html
                    203:     ./ports/arc/index.html
                    204:     ./ports/arm/index.html
                    205:     ./ports/arm26/index.html
                    206:     ./ports/arm32/index.html
                    207:     ./ports/atari/index.html
                    208:     ./ports/bebox/index.html
                    209:     ./ports/cats/index.html
                    210:     ./ports/cesfic/index.html
                    211:     ./ports/cobalt/index.html
                    212:     ./ports/dreamcast/index.html
                    213:     ./ports/emips/index.html
                    214:     ./ports/evbsh3/index.html
                    215:     ./ports/ews4800mips/index.html
                    216:     ./ports/hp300/index.html
                    217:     ./ports/hp700/index.html
                    218:     ./ports/hpcmips/index.html
                    219:     ./ports/hpcsh/index.html
                    220:     ./ports/ia64/index.html
                    221:     ./ports/ibmnws/index.html
                    222:     ./ports/iyonix/index.html
                    223:     ./ports/landisk/index.html
                    224:     ./ports/luna68k/index.html
                    225:     ./ports/mac68k/booter-manual/index.html
                    226:     ./ports/mac68k/index.html
                    227:     ./ports/mac68k/faq/index.html
                    228:     ./ports/mac68k/info/index.html
                    229:     ./ports/mac68k/theobald/index.html
                    230:     ./ports/macppc/index.html
                    231:     ./ports/macppc/SystemDisk-tutorial/index.html
                    232:     ./ports/mipsco/index.html
                    233:     ./ports/mmeye/index.html
                    234:     ./ports/mvme68k/index.html
                    235:     ./ports/mvmeppc/index.html
                    236:     ./ports/netwinder/index.html
                    237:     ./ports/news68k/index.html
                    238:     ./ports/newsmips/index.html
                    239:     ./ports/next68k/index.html
                    240:     ./ports/ofppc/index.html
                    241:     ./ports/pc532/index.html
                    242:     ./ports/pdp10/index.html
                    243:     ./ports/playstation2/index.html
                    244:     ./ports/pmax/index.html
                    245:     ./ports/pmppc/index.html
                    246:     ./ports/prep/index.html
                    247:     ./ports/rs6000/index.html
                    248:     ./ports/s390/index.html
                    249:     ./ports/sandpoint/index.html
                    250:     ./ports/sbmips/index.html
                    251:     ./ports/sgimips/index.html
                    252:     ./ports/sh3/index.html
                    253:     ./ports/shark/index.html
                    254:     ./ports/sun2/index.html
                    255:     ./ports/sun3/index.html
                    256:     ./ports/vax/index.html
                    257:     ./ports/x68k/index.html
                    258:     ./ports/zaurus/index.html
                    259:     ./releases/formal-0.8/index.html
                    260:     ./releases/index.html
                    261:     ./releases/formal-0.9/index.html
                    262:     ./releases/formal-1.0/index.html
                    263:     ./releases/formal-1.1/index.html
                    264:     ./releases/formal-1.2/index.html
                    265:     ./releases/formal-1.3/sun3x/index.html
                    266:     ./releases/formal-1.3/index.html
                    267:     ./releases/formal-1.4/index.html
                    268:     ./releases/formal-1.5/index.html
                    269:     ./releases/formal-1.6/index.html
                    270:     ./releases/formal-2.0/index.html
                    271:     ./releases/formal-3/index.html
                    272:     ./releases/formal-4/index.html
                    273:     ./releases/formal-5/index.html
                    274:     ./releases/formal-6/index.html
                    275:     ./releng/index.html
                    276:     ./sites/index.html
                    277:     ./support/hardware/index.html
                    278:     ./support/index.html
                    279:     ./support/security/index.html
                    280: 
                    281: # Already done
                    282: Those are the index files already transformed by GCi students and not yet in the 
                    283: wiki:
1.2       jdf       284: 
1.1       jdf       285:     ./docs/current/index.html
                    286:     ./docs/network/nsps/index.html
                    287:     ./docs/internals/en/index.html
                    288:     ./ports/xen/index.html
                    289:     ./docs/x/index.html
                    290:     ./docs/misc/index.html
                    291:     ./docs/puffs/index.html
                    292:     ./docs/network/index.html
                    293:     ./docs/guide/en/index.html
                    294: 
                    295: Those are single files which were also done by GCi students:
1.2       jdf       296: 
1.1       jdf       297:     ./docs/bootcd.html
                    298:     http://ftp.netbsd.org/pub/NetBSD/NetBSD-5.1.2/i386/INSTALL.html
                    299:     ./docs/encrypted-iscsi.html
                    300: 
                    301: Those are the ones already in the wiki:
1.2       jdf       302: 
1.1       jdf       303:     ./ports/amd64/index.html
                    304:     ./ports/evbarm/index.html
                    305:     ./ports/evbmips/index.html
                    306:     ./ports/evbppc/index.html
                    307:     ./ports/hpcarm/index.html
                    308:     ./ports/i386/index.html
                    309:     ./ports/sparc/index.html
                    310:     ./ports/sparc64/index.html
                    311:     ./ports/xen
1.4     ! wiki      312:     ./ports/index.html

CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb