| Both sides previous revision Previous revision Next revision | Previous revision |
| wiki:about [2021/11/21 22:20] – Add updated create account instructions, remove 'short version' KubilayKocak | wiki:about [2023/10/11 21:56] (current) – the MaxMind site has been rearranged. MarkLinimon |
|---|
| ===== Introduction ===== | ===== Introduction ===== |
| |
| Please get in touch if you have questions or need help with the wiki, whether relating to accounts, contribution, content or guidelines. | Here are things you need to know about [[http://www.FreeBSD.org|FreeBSD]]'s wiki. Please get in touch if you have questions, ideas or need help with [[Wiki/Contributing|wiki contribution]], content or [[Wiki/Guidelines|editing guidelines]]. |
| |
| ===== Create an Account ===== | ===== Things Users Need To Know ===== |
| |
| - Decide on an %%AccountName%% (username, [[/FirstnameLastname|FirstnameLastname]] preferred) and Email Address for your new account | ==== How To Create an Account ==== |
| - Join #freebsd-wiki (ircs:%%//%%irc.libera.chat/freebsd-wiki) on Libera Chat IRC and request an account, **OR** ... | |
| - Email <wiki-admin@FreeBSD.org> with chosen %%AccountName%% and Email Address. | |
| - [[/WikiAdmin|WikiAdmin]] will create an account for you and add you to [[/ContributorsGroup|ContributorsGroup]] | |
| - [[https://wiki.freebsd.org/action/recoverpass/FrontPage?action=recoverpass|Reset password]] using new %%AccountName%% | |
| - Follow reset password instructions sent to your email | |
| - Have fun editing! | |
| |
| === Reset password === | - Decide on an %%AccountName%% (username, ''%%FirstnameLastname%%'' preferred) and Email Address for your new account. |
| | - [[/WikiAdmin#Contact|Contact WikiAdmin]] via IRC or Email with chosen %%AccountName%% and Email Address. |
| | - [[/WikiAdmin|WikiAdmin]] will create an account for you and add you to [[/ContributorsGroup|ContributorsGroup]]. |
| | - using new %%AccountName%%. |
| | - Follow reset password instructions sent to your email. |
| | - Have fun editing! |
| |
| * [[https://wiki.freebsd.org/action/login/AboutWiki?action=recoverpass|FreeBSD Wiki: Recover password]] | ==== How To Reset Your Password ==== |
| |
| === I lost my account / set a bad email address === | * |
| |
| * Email <wiki-admin@FreeBSD.org> with your %%AccountName%% | ==== How To Recover A Lost Account ==== |
| |
| ==== Long version ==== | * [[/WikiAdmin#Contact|Contact WikiAdmin]] with your %%AccountName%%. |
| |
| **NOTE:** The default ACL / Access Control List setup has changed on the wiki as of 2010-04-12. | ===== Things Administrators Need To Know ===== |
| Developers now don't have access to edit ALL pages, only all pages by default, IE [[/DevelopersGroup|DevelopersGroup]] membership does not override #acl lines on the wiki by default anymore. | |
| This mainly means that if a bad #acl line is added to a page, you now need to ask one of | |
| the [[/WikiAdminGroup|WikiAdmins]] to unbreak it. | |
| The reason for the change is to allow specific pages to have a limited number of people with write access etc. | |
| Please do not abuse this! | |
| |
| Note that as a general rule only %%FreeBSD%% [[/Developers|developers]] and known contributors get access to edit this wiki. If you are actively working on something and would like to help document it in the wiki, feel free to ask a developer for access. | ==== Access Control Lists ==== |
| |
| In practice this is done by the [[/MoinMoin|MoinMoin]] ACL system which by default only lets members of either the [[/DevelopersGroup|DevelopersGroup]] or the [[/ContributorsGroup|ContributorsGroup]] edit wiki pages. The [[/DevelopersGroup|DevelopersGroup]] can edit all pages, except pages explicitly set for more specific edit access using the #acl keyword. All people in the [[/DevelopersGroup|DevelopersGroup]] can add #acl keywords to pages, but please only use this if it's really needed. People in the [[/ContributorsGroup|ContributorsGroup]] can edit all pages by default, except they cannot edit the front page, the Group pages nor set #acl tags on pages. | Two main ACLs exist, modulo more specific ACLs for team or specifric project purposes; [[/ContributorsGroup|ContributorsGroup]] and [[/DevelopersGroup|DevelopersGroup]]. |
| |
| To get access to edit pages create your account. Thereafter you need someone who is already in [[/DevelopersGroup]] to add you to the [[/DevelopersGroup]] page to allow access to edit pages. You can poke your mentor or another committer for this. | * [[/ContributorsGroup|ContributorsGroup]] provides write access to most pages, except for a few important pages, such as the [[/FrontPage|FrontPage]], cannot edit Group pages, nor add #acl keywords. |
| | * [[/DevelopersGroup|DevelopersGroup]] provides access to most/all pages, except for those pages with more restrictive / additional ACLs, and can add #acl keywords. |
| |
| If developers want non-developers/non-committers to have access to the wiki (e.g. for [[/SummerOfCode|SummerOfCode]]), they can be added to the [[/ContributorsGroup]] group. Contributors can edit all but a few selected pages. | ==== MoinMoin ==== |
| |
| See notes about [[/Developers]]. | The wiki is implemented using the [[Wiki/About/MoinMoin]] platform. |
| |
| ==== Known Problems ==== | ==== MoinMoin Modifications ==== |
| |
| * The custom flags are not working | The following modifications have been made to the standard moinmoin installation. These are added here mainly as a help to the admin in case of future upgrade... |
| * self: and wiki: links do not work anymore (note: not sure if this is a bug, or just the new world order) | |
| |
| ===== Modifications ===== | === More country flags === |
| |
| The following modifications have been made to the standard moinmoin. These are added here mainly as a help to the admin in case of future upgrade... | As suggested by [[/SergeyMatveychuk|SergeyMatveychuk]], a bunch of country flags have been added. See the [[/HelpOnSmileys|HelpOnSmileys]] for information on how to use the flags in the wiki. |
| |
| ==== More flags ==== | The flags came from [[https://www.maxmind.com|MaxMind]] and are used here with permission. :!: TODO as of 20231011, the [[https://www.maxmind.com/download/geoip/database/flag.zip|previous download location]] of the flag database is no longer available. It may simply be that one needs a login now. |
| |
| As suggested by [[/SergeyMatveychuk|SergeyMatveychuk]], a bunch of flags has been added. | |
| See the [[/HelpOnSmileys|HelpOnSmileys]] for information on how to use the flags in the wiki. | |
| The flags came from http://www.maxmind.com/download/geoip/database/flag.zip | |
| and are used here with permission. | |
| The following (very elegant!) perl oneliner was used to convert to moinmoin config format: | The following (very elegant!) perl oneliner was used to convert to moinmoin config format: |
| |
| ---- | ---- |
| |
| {{tag>HowTo Wiki Stale}} | {{tag>HowTo Wiki}} |
| |