Help:Howtos - Revision history

Jmandel: how to link

2010-04-04T17:00:15Z

how to link

← Older revision		Revision as of 17:00, 4 April 2010
Line 1:		Line 1:
	''Please follow the same style and headings as the howtos already there.''		''Please follow the same style and headings as the howtos already there.''

	* Keep it simple. It's not the complete documentation, it's just a ~~Howto~~.		* Keep it simple. It's not the complete documentation, it's just a howto.
			* The howtos are sorted alphabetically without the leading "How to". This is achieved by linking to this category like this: <nowiki>[[Category:Howtos\|Run WRF-Fire]]</nowiki>.
	* Give complete, clear, specific step by step instructions to reproduce building the code and running it on a particular problem.		* Give complete, clear, specific step by step instructions to reproduce building the code and running it on a particular problem.
	* It is important that the instructions are self-contained so that they can be discussed on the wiki.		* It is important that the instructions are self-contained so that they can be discussed on the wiki.

Jmandel: be bold

2010-02-01T00:57:21Z

be bold

← Older revision		Revision as of 00:57, 1 February 2010
Line 9:		Line 9:
	* Include some pictures and results.		* Include some pictures and results.
	* Update the page as the codes and data change, but do not delete the information on past working versions.		* Update the page as the codes and data change, but do not delete the information on past working versions.
			* '''Be bold.''' If you do not like the structure of the howtos (or anything else), go ahead to and change it, but then you should eventually change it consistently everywhere.

	Thanks!		Thanks!

Jmandel: moved Help:What should be included in howtos to Help:Howtos

2010-01-27T20:19:12Z

moved Help:What should be included in howtos to Help:Howtos

← Older revision	Revision as of 20:19, 27 January 2010
(No difference)

Jmandel at 20:19, 27 January 2010

2010-01-27T20:19:00Z

← Older revision		Revision as of 20:19, 27 January 2010
Line 13:		Line 13:

	[[Category:Howtos]]		[[Category:Howtos]]
	[[Category:Help]]		[[Category:Help\|Howtos]]

Jmandel: Category:Help

2010-01-27T20:12:57Z

Category:Help

← Older revision		Revision as of 20:12, 27 January 2010
Line 1:		Line 1:

	''Please follow the same style and headings as the howtos already there.''		''Please follow the same style and headings as the howtos already there.''

Line 14:		Line 13:

	[[Category:Howtos]]		[[Category:Howtos]]
			[[Category:Help]]

Jmandel: moved What should be included in howtos to Help:What should be included in howtos: it's a help page

2010-01-27T20:11:51Z

moved What should be included in howtos to Help:What should be included in howtos: it's a help page

← Older revision	Revision as of 20:11, 27 January 2010
(No difference)

Jmandel: /* Suggested contents and style for pages in category Howtos */ Follow the same style and headings as the howtos already there.

2010-01-26T21:34:08Z

Suggested contents and style for pages in category Howtos: Follow the same style and headings as the howtos already there.

← Older revision		Revision as of 21:34, 26 January 2010
Line 1:		Line 1:
	~~==Suggested contents~~ and ~~style for pages in category [[Howtos]]==~~
			''Please follow the same style and headings as the howtos already there.''

	* Keep it simple. It's not the complete documentation, it's just a Howto.		* Keep it simple. It's not the complete documentation, it's just a Howto.

Jmandel: /* Suggested contents and style for pages in category Howtos */

2010-01-19T08:05:32Z

Suggested contents and style for pages in category Howtos

← Older revision		Revision as of 08:05, 19 January 2010
Line 2:		Line 2:

	* Keep it simple. It's not the complete documentation, it's just a Howto.		* Keep it simple. It's not the complete documentation, it's just a Howto.
	* Give clear, specific step by step instructions to reproduce building the code and running it on a particular problem.		* Give complete, clear, specific step by step instructions to reproduce building the code and running it on a particular problem.
	* It~~'s OK to refer to particular README files and such in~~ the ~~source code as long as these give such step by step~~ instructions.		* It is important that the instructions are self-contained so that they can be discussed on the wiki.
	* Do not refer to the documentation. The point of a Howto is to avoid reading the documentation!		* Do not refer to the documentation. The point of a Howto is to avoid reading the documentation!
	* Include links to the code and data repositores, and to the documentation.		* Include links to the code and data repositores, and to the documentation.
	* Identify versions with which it all worked, such as [[git]] commit hash or [[Subversion]] tag for source codes, the date and some checksum (such as [[Wikipedia:cksum\|cksum]], [[Wikipedia:md5sum\|md5sum]]) for data files, and versions of the operating system, compilers, and libraries used.		* Identify versions with which it all worked, such as [[git]] commit hash or [[Subversion]] tag for source codes, the date and some checksum (such as [[Wikipedia:cksum\|cksum]], [[Wikipedia:md5sum\|md5sum]]) for data files, and versions of the operating system, compilers, and libraries used.

Jmandel: need step by step instructions

2010-01-18T05:13:56Z

need step by step instructions

← Older revision		Revision as of 05:13, 18 January 2010
Line 2:		Line 2:

	* Keep it simple. It's not the complete documentation, it's just a Howto.		* Keep it simple. It's not the complete documentation, it's just a Howto.
	* Give ~~minimal information needed~~ to reproduce building the code and running it on a particular problem. It's OK to refer to ~~specific~~ README files in the source code ~~for details~~.		* Give clear, specific step by step instructions to reproduce building the code and running it on a particular problem.
			* It's OK to refer to particular README files and such in the source code as long as these give such step by step instructions.
			* Do not refer to the documentation. The point of a Howto is to avoid reading the documentation!
	* Include links to the code and data repositores, and to the documentation.		* Include links to the code and data repositores, and to the documentation.
	* ~~Record~~ versions with which it all worked, such as [[git]] commit hash or [[Subversion]] tag for source codes, the date and some checksum (such as [[Wikipedia:cksum\|cksum]], [[Wikipedia:md5sum\|md5sum]]) for data files, and versions of the operating system, compilers, and libraries used.		* Identify versions with which it all worked, such as [[git]] commit hash or [[Subversion]] tag for source codes, the date and some checksum (such as [[Wikipedia:cksum\|cksum]], [[Wikipedia:md5sum\|md5sum]]) for data files, and versions of the operating system, compilers, and libraries used.
	* Include some pictures and results.		* Include some pictures and results.
	* Update the page as the codes and data change, but do not delete the information on past working versions.		* Update the page as the codes and data change, but do not delete the information on past working versions.

Jmandel: /* Suggested contents and style for pages in category Howtos */

2010-01-17T06:34:09Z

Suggested contents and style for pages in category Howtos

← Older revision		Revision as of 06:34, 17 January 2010
Line 4:		Line 4:
	* Give minimal information needed to reproduce building the code and running it on a particular problem. It's OK to refer to specific README files in the source code for details.		* Give minimal information needed to reproduce building the code and running it on a particular problem. It's OK to refer to specific README files in the source code for details.
	* Include links to the code and data repositores, and to the documentation.		* Include links to the code and data repositores, and to the documentation.
	* Record versions with which it all worked, such as [[~~Wikipedia:git (software)\|~~git]] commit hash or [[~~Wikipedia:Subversion (software)\|~~Subversion]] tag for source codes, the date and some checksum (such as [[Wikipedia:cksum\|cksum]], [[Wikipedia:md5sum\|md5sum]]) for data files, and versions of the operating system, compilers, and libraries used.		* Record versions with which it all worked, such as [[git]] commit hash or [[Subversion]] tag for source codes, the date and some checksum (such as [[Wikipedia:cksum\|cksum]], [[Wikipedia:md5sum\|md5sum]]) for data files, and versions of the operating system, compilers, and libraries used.
	* Include some pictures and results.		* Include some pictures and results.
	* Update the page as the codes and data change, but do not delete the information on past working versions.		* Update the page as the codes and data change, but do not delete the information on past working versions.