Gentoo Wiki talk:Contributor's guide

Note
Before creating a discussion or leaving a comment, please read about using talk pages. To create a new discussion, click here. Comments on an existing discussion should be signed using ~~~~:

A comment [[User:Larry|Larry]] 13:52, 13 May 2024 (UTC)
: A reply [[User:Sally|Sally]] 11:34, 5 November 2024 (UTC)
:: Your reply ~~~~

Merge from Help:Editing pages

Talk status

This discussion is done as of Dec 13, 2021.

I've merged the contents of Help:Editing pages here, as these two pages seem to cover essentially the same subject. The wiki help documentation is already split into quite a few documents from where to read introductory editing information: with these two, Gentoo_Wiki:Guidelines, Formatting, the Project:Wiki page, and Project:Council/Code_of_conduct.

If this is unwise, please revert the last edit to this page. If not, I'll redirect links from Help:Editing pages to here, and mark that page for deletion. I'll wait a little before continuing edits to this article, in case it gets reverted.

-- Ris (talk) 01:05, 15 November 2021 (UTC)

Any page in the Help namespace is often created by the mediawiki software and is required to exist. Upon upgrade if it does not exist, will just be restored anyway. --Grknight (talk) 01:25, 15 November 2021 (UTC)

I see, thanks!!

Might it be an idea to integrate the contributor guide to Help:Editing pages then? Or redirect that page to the guide ?

-- Ris (talk) 01:30, 15 November 2021 (UTC)

No. We would want to keep them as separate articles to reduce headaches in merging content in the future upon wiki upgrades... I think it would be a good idea to link the two pages in the See also section, if not done so already. Wiki text is more difficult to merge than code. I think this discussion can be closed. --Maffblaster (talk) 22:05, 13 December 2021 (UTC)

Oh, I had completely forgotten about this discussion, sorry, it's now "obsolete". The Help:Editing_pages page is now totally different: it only contains info about the "edit" MediaWiki page, and all relevant content is merged to the "contributes guide". Sorry for not closing this earlier. -- Ris (talk) 22:14, 13 December 2021 (UTC)

Cmd

Talk status

This discussion is still ongoing as of 2024-08-01.

It says to use the C template for commands meant to be typed into the terminal. I think that's a mistake. The Cmd template should be used for that. For instance, see which of the two below get the point across that the reader is meant to run "nano /etc/portage/make.conf". With C: nano /etc/portage/make.conf. With Cmd:

user $nano /etc/portage/make.conf

.

4man (talk) 15:00, 1 August 2024 (UTC)

The word "command" should probably be replaced with "tool name", so that if a tool is mentioned, {{C}} is used, if the actual command to run is provided, {{Cmd}} (or {{RootCmd}}) is used. As an example: The file can be edited with nano as follows:

user $nano /path/to/file

Anyway, is there a reason why <code></code> is not mentioned? --Lars Hint (talk) 16:14, 1 August 2024 (UTC)

I agree. However, {{Cmd}} creates a block element on a new line, and therefore isn't a complete substitute for {{C}}.

Since bash is a programming language, I would consider anything typed into a shell prompt to be code. I therefore think <code> should be used for commands to run that are part of a sentence, such as in the following sentence:

/var/cache/edb/mtimedb is read from whenever emerge --resume is run.