Size: 1362
Comment:
|
Size: 2199
Comment: Add PagesNeedingLove link, mention section numbers
|
Deletions are marked like this. | Additions are marked like this. |
Line 19: | Line 19: |
''' We should probably have a style guide so that all volunteers are on the same page -- are there any good style guides avialable for wikis that we'd like to use? ''' -- RyanMikulovsky | == Style guide == === Template === Here's a basic template to apply when making new pages and revising old ones. {{{ Description of page. I.e.: This page describes how to filter your email using procmail and Exim. ## Every page should have a table of contents [[TableOfContents]] Remaining content of page, split into logical sections. }}} === Section numbers === If the page is the main page, or exactly one degree away from it, then you should include the following text at the very top of the page, which turns off numbering of headings. This may be used on other pages at the discretion of those who keep the wiki up-to-date. {{{ #pragma section-numbers off }}} === Writing style === It would probably be best to use "you" (second-person) when writing the MemberManual. The AdminManual (basically just a re-org of NewServerSetup) should be in third-person. |
Line 22: | Line 51: |
MichaelOlson would like to be in charge of this effort. | MichaelOlson is in charge of this effort. |
Line 24: | Line 53: |
If you want to have charge of a particular page or topic, please indicate this below. | If you want to help out with a particular page or topic, please indicate this below. |
Line 31: | Line 60: |
We have just started. |
* RewriteGoals/PagesToDelete: Pages that need to be deleted. * RewriteGoals/PagesNeedingLove: Pages that need some attention, but should not be deleted. |
This page describes the effort to bring the wiki up-to-date with respect to the new setup.
1. Context
The information on this wiki needs to be made accurate with the current setup (deleuze, mire, abulafia, etc.).
This involves:
- Updating information on existing pages
- Deleting pages that have no useful content
- Make it easy for members to get up-to-speed on migration,
Re-work WelcomePage to be more relevant and easy to browse
Provide more examples on ["DomTool/Examples"] and on MigrationTips
Making an HCoop "Member Manual", perhaps by using MemberManual for the start page, with chapters represented as subpages
- Making a migration FAQ that answers all questions that members are likely to have during migration
2. Style guide
2.1. Template
Here's a basic template to apply when making new pages and revising old ones.
Description of page. I.e.: This page describes how to filter your email using procmail and Exim. ## Every page should have a table of contents [[TableOfContents]] Remaining content of page, split into logical sections.
2.2. Section numbers
If the page is the main page, or exactly one degree away from it, then you should include the following text at the very top of the page, which turns off numbering of headings. This may be used on other pages at the discretion of those who keep the wiki up-to-date.
#pragma section-numbers off
2.3. Writing style
It would probably be best to use "you" (second-person) when writing the MemberManual.
The AdminManual (basically just a re-org of NewServerSetup) should be in third-person.
3. Personnel
MichaelOlson is in charge of this effort.
If you want to help out with a particular page or topic, please indicate this below.
Name |
Pages / topics |
Parts of Non-technical administrative stuff? |
|
Basic account usage |
4. Progress
RewriteGoals/PagesToDelete: Pages that need to be deleted.
RewriteGoals/PagesNeedingLove: Pages that need some attention, but should not be deleted.