Difference between revisions of "Openembedded.org talk:Help"

From Openembedded.org
Jump to: navigation, search
(needs to be in a category)
(Undo revision 3392 by Yjytalamago (Talk))
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
''This is a first proposal for the OE-wiki help page. Please add comments below the proposal.''
+
== Naming Conventions ==
--------
 
<span style="color:blue">
 
'''This page describes principles and guidelines for using this wiki (not Openembedded itself). Understand this as a best-practice suggestion. Try to follow it. But nobody will punish you if not.''' ;-)
 
  
== Naming ==
+
Hi [[User:Laibsch|Laibsch]], it seems that you are the most active admin in this wiki. I would suggest to create a little '''naming policy''' for the OE-wiki. Because MediaWiki has no need to use WikiWords i belive we should use the original, ''official'' naming from the outer world (e.g. Openmoko instead of OpenMoko) and avoid abbreviations (see [[Category_talk:Dev]]). This would make the wiki much more useful, especially for beginners. If you agree it would be a good idea to create a page to fix these rules. It would also be good to have an own MediaWiki namespace different from the OE stuff for such administrative pages. -- [[User:Sledz|SSZ]] 11:23, 9 February 2009 (UTC)
* The names of articles should be optimized for ''readers'' over ''editors''.
 
* Use the original, ''official'' naming from the outer world (for example, Openmoko instead of OpenMoko) with a reasonable minimum of ambiguity.
 
* Do not capitalize second and subsequent words unless the title is almost always capitalized in English (for example, proper names).
 
* In general only create page titles that are in the singular, unless that noun is always in a plural form in English.
 
* Avoid the use of abbreviations, including acronyms, in page naming unless the term you are naming is almost exclusively known only by its abbreviation and is widely known and used in that form.
 
* Page names should not begin with non-alphanumeric characters.
 
* Do not use an article name that suggests a hierarchy of articles.
 
  
== Style ==
+
:Sledz, thank you for your suggestion to which I am very open. Are you familiar with Mediawiki, interested in helping with the admin work and willing to put forward a proposal? --[[User:Laibsch|Laibsch]] 04:47, 10 February 2009 (UTC)
* Style and formatting should be applied consistently within articles, though not necessarily throughout the wiki as a whole.  
 
* Titles should be short—preferably fewer than ten words.
 
* Section names should preferably be unique within a page.
 
* For acronyms and abbreviations write out both the full version and the abbreviation at first occurrence.
 
* The use of abbreviations should be avoided when they would be confusing to the reader. Do not invent abbreviations or acronyms.
 
* Use the simplest markup to display information in a useful and comprehensible way. Markup may appear differently in different browsers. Use HTML and CSS markup sparingly and only with good reason. Minimizing markup in entries allows easier editing.
 
  
== Categorization ==
+
:added on Feb 13th: I think Dev is OK, btw. Many people use the word Dev in conversations like "I am not a dev".  I don't have a strong opinion on this particular one, though. --[[User:Laibsch|Laibsch]] 08:05, 13 February 2009 (UTC)
* Every page should belong to at least one category. An article's category or categories should reflect the topics and classes that are directly related to the subject. In writing an article, use the most likely categories in which the reader would look for, if they are not sure of where to find the article.
 
</span>
 
-------------
 
  
== needs to be in a category ==
+
::I'm a wikipedia user for a long time and run a tiny, private mediawiki for myself. So i believe i can help with the admin work. And yes, i'm willing to make a proposal. May be [[Openembedded:Help]] (aka helppage in the [[MediaWiki:Sidebar]]) could be a good starting point. -- [[User:Sledz|Sledz]] 18:49, 10 February 2009 (UTC)
  
I don't think every page needs to be in a category. --[[User:Laibsch|Laibsch]] 07:59, 13 February 2009 (UTC)
+
::: Go right ahead and formulate your proposal (can be rough at first IMHO).  I'll then discuss upping your privs with the other admins so you can do the actual implementation.  Feel free to do what you can already do without admin privs right now.  That will only make the case for increased privs for you stronger. --[[User:Laibsch|Laibsch]] 05:16, 11 February 2009 (UTC)
 +
 
 +
:::: OK, i'll do my very best.  ;-) -- [[User:Sledz|Sledz]] 13:18, 11 February 2009 (UTC)
 +
 
 +
:::: You can find my first proposal under [[Openembedded talk:Help]]. If the are no objections i would move this to [[Openembedded:Help]] after a while. -- [[User:Sledz|Sledz]] 19:06, 11 February 2009 (UTC)
 +
 
 +
::::: Looks good to me.  Just two comments, I don't think every page needs to be in a category.  Secondly, the text should clearly state from the beginning that this is best-practice not dogma.  I'd appreciate any contribution, no matter the form, over people being scared to contribute.  This wiki is still legible, I think, we don't need to be too rigid.  I guess we can just let users contribute.  If they want to follow our guidelines, more power to them.  If not, we can correct their "mistakes" as wiki maintainers. Thank you very much for your work in this domain. --[[User:Laibsch|Laibsch]] 07:59, 13 February 2009 (UTC)
  
 
: It's not a ''need'' but a ''should''. And i believe it is very helpful. If we see this help not as a dogma (as stated above) i propose to keep this point. -- [[User:Sledz|Sledz]] 11:46, 14 February 2009 (UTC)
 
: It's not a ''need'' but a ''should''. And i believe it is very helpful. If we see this help not as a dogma (as stated above) i propose to keep this point. -- [[User:Sledz|Sledz]] 11:46, 14 February 2009 (UTC)
  
== best-practice not dogma ==
+
:: should in open-source is a requirement.  I'd rather have people add a page than giving up because they don't know about categories. --[[User:Laibsch|Laibsch]] 08:53, 25 February 2009 (UTC)
 +
 
 +
: Yes, i agree with this ''best practise'' instead of ''dogma''. I'll change the proposal. -- [[User:Sledz|Sledz]] 08:56, 13 February 2009 (UTC)
 +
 
 +
:: The text is quite long and I have to admit that even I as admin don't want to read it that much ;-)  I think we're doing mostly fine with the wiki, aren't we?  I still think putting these thoughts in writing is a good start.  Instead of making this "in-your-face" as the next step, I suggest for interested parties to clean up the current wiki according to this policy.  This will also indicate to us if we need to communicate this soft policy stronger or if the current and ongoing patrolling of the wiki is sufficient. --[[User:Laibsch|Laibsch]] 09:02, 25 February 2009 (UTC)
 +
 
 +
Can we move this diskussion to [[Openembedded talk:Help]]? That would be a better place. And yes, i agree with this ''best practise'' instead of ''dogma''. I'll change the proposal. -- [[User:Sledz|Sledz]] 08:56, 13 February 2009 (UTC)
 +
 
 +
: I've moved my proposal to the Openembedded namespace now. Would be nice, if you can reenable '''** helppage|help''' in the [[MediaWiki:Sidebar]]. -- [[User:Sledz|Sledz]] 13:32, 16 February 2009 (UTC)
 +
 
 +
:: Thank you for all the hard work and your nagging (which I need at times ;-)).  I don't want to make this too much "in-your-face" at the moment.  Let the suggestions you made simmer for a while, we can already make changes in their spirit.  At a later point in time we should decide whether this policy needs to be communicated more clearly. --[[User:Laibsch|Laibsch]] 09:16, 25 February 2009 (UTC)
 +
 
 +
::: OK, let it ripe. But we should announce this proposal to get more feedback from the community (especially from the other wiki admins). I read your comment to the [[MediaWiki:Sidebar]]. Why not link now? If the acceptance for the proposal is low, we can change it at any time. -- [[User:Sledz|Sledz]] 18:23, 25 February 2009 (UTC)
  
The text should clearly state from the beginning that this is best-practice not dogma.  I'd appreciate any contribution, no matter the form, over people being scared to contribute.  This wiki is still legible, I think, we don't need to be too rigid.  I guess we can just let users contribute.  If they want to follow our guidelines, more power to them.  If not, we can correct their "mistakes" as wiki maintainers. --[[User:Laibsch|Laibsch]] 07:59, 13 February 2009 (UTC)
+
== [[Openembedded:Copyrights]] ==
  
: Yes, i agree with this ''best practise'' instead of ''dogma''. I'll change the proposal. -- [[User:Sledz|Sledz]] 08:56, 13 February 2009 (UTC)
+
There is a link to [[Openembedded:Copyrights]] below the text box when editing pages. I think there should be a valid copyright text. -- [[User:Sledz|Sledz]] 13:20, 11 February 2009 (UTC)
 +
 
 +
: This is a wiki.  Feel free to edit any non-blocked pages. In the worst case, people will edit it back and revert your changes. --[[User:Laibsch|Laibsch]] 07:54, 13 February 2009 (UTC)
 +
 
 +
:: That's clear. But a copyright should not be a free-editable page. There should be a clear statement on the copyright by the the operator of the wiki. Same for [[Openembedded:General disclaimer]], [[Openembedded:Privacy policy]], and [[Openembedded:About]]. -- [[User:Sledz|Sledz]] 08:52, 13 February 2009 (UTC)
 +
 
 +
== Plugins ==
 +
 
 +
I think these two mediawiki extensions could be helpful:
 +
* http://www.mediawiki.org/wiki/Extension:SyntaxHighlight
 +
* http://www.mediawiki.org/wiki/Extension:Emoticons
 +
-- [[User:Sledz|Sledz]] 08:33, 16 February 2009 (UTC)
 +
 
 +
: I'm not a big fan of even more graphical smileys.  Please point out pages in the wiki that you think would benefit from syntax highlighting. --[[User:Laibsch|Laibsch]] 09:12, 25 February 2009 (UTC)
 +
 
 +
:: The syntax highlighting could improve e.g. [[Bitbake]]. And often some tiny smileys make the live more pleasant. ;-) -- [[User:Sledz|Sledz]] 18:27, 25 February 2009 (UTC)
 +
 
 +
::: Do you have more examples for Highlighting?  --[[User:Laibsch|Laibsch]] 19:50, 3 March 2009 (UTC)

Latest revision as of 07:39, 24 November 2010

Naming Conventions

Hi Laibsch, it seems that you are the most active admin in this wiki. I would suggest to create a little naming policy for the OE-wiki. Because MediaWiki has no need to use WikiWords i belive we should use the original, official naming from the outer world (e.g. Openmoko instead of OpenMoko) and avoid abbreviations (see Category_talk:Dev). This would make the wiki much more useful, especially for beginners. If you agree it would be a good idea to create a page to fix these rules. It would also be good to have an own MediaWiki namespace different from the OE stuff for such administrative pages. -- SSZ 11:23, 9 February 2009 (UTC)

Sledz, thank you for your suggestion to which I am very open. Are you familiar with Mediawiki, interested in helping with the admin work and willing to put forward a proposal? --Laibsch 04:47, 10 February 2009 (UTC)
added on Feb 13th: I think Dev is OK, btw. Many people use the word Dev in conversations like "I am not a dev". I don't have a strong opinion on this particular one, though. --Laibsch 08:05, 13 February 2009 (UTC)
I'm a wikipedia user for a long time and run a tiny, private mediawiki for myself. So i believe i can help with the admin work. And yes, i'm willing to make a proposal. May be Openembedded:Help (aka helppage in the MediaWiki:Sidebar) could be a good starting point. -- Sledz 18:49, 10 February 2009 (UTC)
Go right ahead and formulate your proposal (can be rough at first IMHO). I'll then discuss upping your privs with the other admins so you can do the actual implementation. Feel free to do what you can already do without admin privs right now. That will only make the case for increased privs for you stronger. --Laibsch 05:16, 11 February 2009 (UTC)
OK, i'll do my very best.  ;-) -- Sledz 13:18, 11 February 2009 (UTC)
You can find my first proposal under Openembedded talk:Help. If the are no objections i would move this to Openembedded:Help after a while. -- Sledz 19:06, 11 February 2009 (UTC)
Looks good to me. Just two comments, I don't think every page needs to be in a category. Secondly, the text should clearly state from the beginning that this is best-practice not dogma. I'd appreciate any contribution, no matter the form, over people being scared to contribute. This wiki is still legible, I think, we don't need to be too rigid. I guess we can just let users contribute. If they want to follow our guidelines, more power to them. If not, we can correct their "mistakes" as wiki maintainers. Thank you very much for your work in this domain. --Laibsch 07:59, 13 February 2009 (UTC)
It's not a need but a should. And i believe it is very helpful. If we see this help not as a dogma (as stated above) i propose to keep this point. -- Sledz 11:46, 14 February 2009 (UTC)
should in open-source is a requirement. I'd rather have people add a page than giving up because they don't know about categories. --Laibsch 08:53, 25 February 2009 (UTC)
Yes, i agree with this best practise instead of dogma. I'll change the proposal. -- Sledz 08:56, 13 February 2009 (UTC)
The text is quite long and I have to admit that even I as admin don't want to read it that much ;-) I think we're doing mostly fine with the wiki, aren't we? I still think putting these thoughts in writing is a good start. Instead of making this "in-your-face" as the next step, I suggest for interested parties to clean up the current wiki according to this policy. This will also indicate to us if we need to communicate this soft policy stronger or if the current and ongoing patrolling of the wiki is sufficient. --Laibsch 09:02, 25 February 2009 (UTC)

Can we move this diskussion to Openembedded talk:Help? That would be a better place. And yes, i agree with this best practise instead of dogma. I'll change the proposal. -- Sledz 08:56, 13 February 2009 (UTC)

I've moved my proposal to the Openembedded namespace now. Would be nice, if you can reenable ** helppage|help in the MediaWiki:Sidebar. -- Sledz 13:32, 16 February 2009 (UTC)
Thank you for all the hard work and your nagging (which I need at times ;-)). I don't want to make this too much "in-your-face" at the moment. Let the suggestions you made simmer for a while, we can already make changes in their spirit. At a later point in time we should decide whether this policy needs to be communicated more clearly. --Laibsch 09:16, 25 February 2009 (UTC)
OK, let it ripe. But we should announce this proposal to get more feedback from the community (especially from the other wiki admins). I read your comment to the MediaWiki:Sidebar. Why not link now? If the acceptance for the proposal is low, we can change it at any time. -- Sledz 18:23, 25 February 2009 (UTC)

Openembedded:Copyrights

There is a link to Openembedded:Copyrights below the text box when editing pages. I think there should be a valid copyright text. -- Sledz 13:20, 11 February 2009 (UTC)

This is a wiki. Feel free to edit any non-blocked pages. In the worst case, people will edit it back and revert your changes. --Laibsch 07:54, 13 February 2009 (UTC)
That's clear. But a copyright should not be a free-editable page. There should be a clear statement on the copyright by the the operator of the wiki. Same for Openembedded:General disclaimer, Openembedded:Privacy policy, and Openembedded:About. -- Sledz 08:52, 13 February 2009 (UTC)

Plugins

I think these two mediawiki extensions could be helpful:

-- Sledz 08:33, 16 February 2009 (UTC)

I'm not a big fan of even more graphical smileys. Please point out pages in the wiki that you think would benefit from syntax highlighting. --Laibsch 09:12, 25 February 2009 (UTC)
The syntax highlighting could improve e.g. Bitbake. And often some tiny smileys make the live more pleasant. ;-) -- Sledz 18:27, 25 February 2009 (UTC)
Do you have more examples for Highlighting? --Laibsch 19:50, 3 March 2009 (UTC)