File:  [NetBSD Developer Wiki] / wikisrc / htdocs_migration.mdwn
Revision 1.8: download - view: text, annotated - select for diffs
Thu May 2 11:06:44 2019 UTC (11 months, 1 week ago) by sevan
Branches: MAIN
CVS tags: HEAD
jdf resigned sometime ago

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

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