Wiki editing conventions - Revision history

StefanoZacchiroli: move here interwiki information from private wiki page

2018-07-13T14:33:36Z

move here interwiki information from private wiki page

← Older revision		Revision as of 14:33, 13 July 2018
Line 31:		Line 31:
	# create a dedicated page (e.g., [[GitHub]])		# create a dedicated page (e.g., [[GitHub]])
	# replace previous links to the external website, with links to the internal page		# replace previous links to the external website, with links to the internal page

			== Interwikis ==

			The following [https://www.mediawiki.org/wiki/Manual:Interwiki interwikis] are configured to ease linking (and redirect, reuse templates, etc.) among Software Heritage wikis:

			* '''swhwiki''': links to the [[public wiki]]; here is a [[swhwiki:Suggestion box\|sample link]]


	[[Category:Wiki help]]		[[Category:Wiki help]]

StefanoZacchiroli: 1 revision: import public pages from the intranet wiki

2016-07-20T13:02:36Z

1 revision: import public pages from the intranet wiki

← Older revision	Revision as of 13:02, 20 July 2016
(No difference)

StefanoZacchiroli at 19:28, 29 May 2015

2015-05-29T19:28:24Z

New page

This page is about the editing conventions used on this wiki.

== General wisdom ==

As far as possible/relevant, we try to follow [https://en.wikipedia.org/wiki/Category:Wikipedia_editing_guidelines wikipedia editing guidelines], just to have a sane and well-known default. '''When in doubt, do as Wikipedia does.'''

Exceptions relevant to [[Software Heritage]], ''ad hoc'' guidelines, or details worth recalling are listed below.

== Page titles ==

Conventions to name pages in this wiki (including categories)

* page titles are ''not'' written in <strike>CamelCaseStyle</strike>
* rather: use '''spaces between words''' and let MediaWiki turn them into underscores in page URLs for you
* use [https://en.wikipedia.org/wiki/Letter_case#Sentence_case '''sentence case'''] in page titles, i.e.:
** always capitalize the first word
** capitalize subsequent words only for proper nouns
** example: this page title is "Wiki editing conventions"

== Page creation ==

when do we create a page dedicated to a specific topic?

* when a single link to the corresponding external resource (e.g., external) website is no longer enough
* otherwise, we just create a link to the external resource

typical life cycle of information about an external resource (e.g., GitHub) is therefore:

# add a link to its website (e.g., https://github.com) from another, more general page (e.g., [[Forges]])
# discover that we need to add more information, possibly [[Software Heritage]]-specific (e.g., information on how to scrape GitHub)
# create a dedicated page (e.g., [[GitHub]])
# replace previous links to the external website, with links to the internal page

[[Category:Wiki help]]