Template:AppStub - Revision history

Jpr@uab.edu: Convert to App instead of software to match RCS app philosophy. Add intro reference to tell people what to do in stub.

2013-10-30T16:52:24Z

Convert to App instead of software to match RCS app philosophy. Add intro reference to tell people what to do in stub.

← Older revision		Revision as of 16:52, 30 October 2013
Line 1:		Line 1:
	'''{{{1}}}'''		'''{{{1}}}'''

	A short blurb about what this ~~software~~ does and who might be interested in using it. You should provide a link to the [http://example.org upstream project]. A [[wikipedia:Wikipedia\|Wikipedia page name]] reference can be helpful here, if it it exists.		This is the AppStub template. Replace it's content with your own content for your specific App. See [[AppBuidBestPractices#At_a_minimum.2C_document_your_effort_in_the_docs_wiki\|App Build Best Practices]] for more information.

			First write a short blurb about what this App does and who might be interested in using it. You should provide a link to the [http://example.org upstream project]. A [[wikipedia:Wikipedia\|Wikipedia page name]] reference can be helpful here, if it it exists.

	== How to use {{{1}}} ==		== How to use {{{1}}} ==

Jpr@uab.edu: Jpr@uab.edu moved page Template:SoftwareStub to Template:AppStub: Use naming more consistent with the philosophy of the RCS

2013-10-30T16:47:45Z

Jpr@uab.edu moved page Template:SoftwareStub to Template:AppStub: Use naming more consistent with the philosophy of the RCS

← Older revision	Revision as of 16:47, 30 October 2013
(No difference)

Jpr@uab.edu: /* How to build {{{1}}} */ Fix link to App best practices page

2013-10-30T16:47:00Z

How to build {{{1}}}: Fix link to App best practices page

← Older revision		Revision as of 16:47, 30 October 2013
Line 17:		Line 17:
	''NOTE: This is critical to reproducible research and should be considered a core part of your research notebook.''		''NOTE: This is critical to reproducible research and should be considered a core part of your research notebook.''

	Make sure you are using [[~~SoftwareBuildBestPractices~~]]		Make sure you are using [[AppBuildBestPractices]]

	== Getting Help ==		== Getting Help ==

Jpr@uab.edu: Stub page for software installed on the cluster

2013-10-30T16:05:14Z

Stub page for software installed on the cluster

New page

'''{{{1}}}'''

A short blurb about what this software does and who might be interested in using it. You should provide a link to the [http://example.org upstream project]. A [[wikipedia:Wikipedia|Wikipedia page name]] reference can be helpful here, if it it exists.

== How to use {{{1}}} ==

How to use the software. Describe how to use it on the cluster by setting your environment.

Better yet, write a modules file and tell folks what module they need to load

module load {{{1}}}

== How to build {{{1}}} ==

Describe the steps followed to build this software.

''NOTE: This is critical to reproducible research and should be considered a core part of your research notebook.''

Make sure you are using [[SoftwareBuildBestPractices]]

== Getting Help ==

If you are providing support for this software on the cluster let folks know how to reach you. At least let the know where they can find help online in the upstream community.

== References ==

At a minimum record the link to the upstream project from where you got this software.

See [[Editing_Docs]] for information on how to edit pages on this site.