Difference between revisions of "Snicdocs"
| Line 7: | Line 7: | ||
}} | }} | ||
| − | Snicdocs is the working name for the wiki you are now reading. Its purpose is to become ''the'' place | + | Snicdocs is the working name for the wiki you are now reading. Its purpose is to become ''the'' place for user oriented information in Swedish academic high performance computing. Some examples include: |
* What computing resources are available. | * What computing resources are available. | ||
| Line 15: | Line 15: | ||
* Who are the people I can get help from? | * Who are the people I can get help from? | ||
| − | + | This wiki will also be used to advertise projects and activities within Swedish academic HPC. | |
| − | The contents of this wiki is kept current by application and systems experts in the Swedish research and HPC communities, and members of the general public can contribute by asking questions and posting comments on the "Discussion" pages, which accompany every normal wiki page (see tab on top of page). | + | The idea is that Snicdocs should contain information applicable across all centers in Sweden, and link to original source for documentation that is valid worldwide. And conversely, link to local pages at specific centres for information on local implementations that are is different enough to warrant special description. Consequentially, it is a goal to keep Snicdocs and local pages as empty as possible, and instead strive to remove special cases, harmonize solutions, and to work to improve upstream documentation so that everything works as expected worldwide. An added benefit is that a wiki with less words and special cases is both easier to read and to keep up to date. |
| + | |||
| + | The contents of this wiki is kept current by application and systems experts in the Swedish research and HPC communities, and members of the general public can contribute by asking questions and posting comments on the "Discussion" pages, which accompany every normal wiki page (see tab on top of page). Snicdocs uses browser client certificates for authorization of editors. | ||
== Development == | == Development == | ||
| − | Since the content contributors | + | Since the Snicdocs content contributors are distributed throughout Sweden, and opportunities for face-to-face meetings are infrequent, it is necessary for this system to be straightforward to keep current and consistent. Therefore, Snicdocs uses the widely known [http://mediawiki.org mediawiki] software (used also by for example [http://wikipedia.org Wikipedia]) with [http://semantic-mediawiki.org semantic mediawiki] added for dynamic generation of content and for minimizing duplication of data. On top of this it requires well-defined scope and structure to ensure searchability and readability. |
| − | Most of the development of Snicdocs has gone into ensuring that best way to enter information into the wiki also is the easiest way, so that new data will be added in a readable, consistent, homogeneous and searchable manner. In practical terms this means determining useful category hierarchies for relevant topics, so that relevant pages | + | Most of the development of Snicdocs has gone into ensuring that best way to enter information into the wiki also is the easiest way, so that new data will be added in a readable, consistent, homogeneous and searchable manner. In practical terms this means determining useful category hierarchies for relevant topics, so that relevant pages can be found easily, and determining minimal useful sets of required information on pages within these topics, so that contributors can spend their time adding content rather than fulfilling arbitrary and sometimes inapplicable restrictions. Another major part has been writing reusable page templates and example pages for these topics, and to present sufficiently clear and concise editing guidelines so that our disparate and distributed editor community can still provide a homogeneous browsing experience for the users. |
Snicdocs is hosted by [[NSC]] and developed mostly by [[User:Joel Hedlund (NSC)]]. | Snicdocs is hosted by [[NSC]] and developed mostly by [[User:Joel Hedlund (NSC)]]. | ||
Revision as of 12:36, 12 March 2012
| Name | Snicdocs |
|---|---|
| Description | A knowledgebase of user oriented information in Swedish academic high performance computing. |
| Project financing | SNIC |
| Is active | yes |
| Start date | 2011-05-20 |
| End date |
Snicdocs is the working name for the wiki you are now reading. Its purpose is to become the place for user oriented information in Swedish academic high performance computing. Some examples include:
- What computing resources are available.
- What storage solutions are available?
- What software is available where, and under what conditions?
- How can I use them?
- Who are the people I can get help from?
This wiki will also be used to advertise projects and activities within Swedish academic HPC.
The idea is that Snicdocs should contain information applicable across all centers in Sweden, and link to original source for documentation that is valid worldwide. And conversely, link to local pages at specific centres for information on local implementations that are is different enough to warrant special description. Consequentially, it is a goal to keep Snicdocs and local pages as empty as possible, and instead strive to remove special cases, harmonize solutions, and to work to improve upstream documentation so that everything works as expected worldwide. An added benefit is that a wiki with less words and special cases is both easier to read and to keep up to date.
The contents of this wiki is kept current by application and systems experts in the Swedish research and HPC communities, and members of the general public can contribute by asking questions and posting comments on the "Discussion" pages, which accompany every normal wiki page (see tab on top of page). Snicdocs uses browser client certificates for authorization of editors.
Development
Since the Snicdocs content contributors are distributed throughout Sweden, and opportunities for face-to-face meetings are infrequent, it is necessary for this system to be straightforward to keep current and consistent. Therefore, Snicdocs uses the widely known mediawiki software (used also by for example Wikipedia) with semantic mediawiki added for dynamic generation of content and for minimizing duplication of data. On top of this it requires well-defined scope and structure to ensure searchability and readability.
Most of the development of Snicdocs has gone into ensuring that best way to enter information into the wiki also is the easiest way, so that new data will be added in a readable, consistent, homogeneous and searchable manner. In practical terms this means determining useful category hierarchies for relevant topics, so that relevant pages can be found easily, and determining minimal useful sets of required information on pages within these topics, so that contributors can spend their time adding content rather than fulfilling arbitrary and sometimes inapplicable restrictions. Another major part has been writing reusable page templates and example pages for these topics, and to present sufficiently clear and concise editing guidelines so that our disparate and distributed editor community can still provide a homogeneous browsing experience for the users.
Snicdocs is hosted by NSC and developed mostly by User:Joel Hedlund (NSC).
Members
| Centre | Role | Field | |
|---|---|---|---|
| Torben Rasmussen (NSC) | NSC | Application expert | Computational chemistry |
