Extension:CentralNotice/Notes/Documentation rewrite
Existing documentation
[edit]- Extension:CentralNotice General intro for developers, installation instructions, terminology and general usage.
- Subpages of Extension:CentralNotice Hodgepodge of notes and explanations, some current and some not.
- Help:CentralNotice General instructions for CentralNotice administrators.
- Subpages of Help:CentralNotice Outdated instructions, announcements and notes.
- CentralNotice Links and summaries for several bits of CentralNotice documentation for administrators, translators and users in general.
- Subpages of CentralNotice Outdated instructions, announcements, translations and requests for translation.
- CentralNotice Outdated info, mainly on operations- and dev-related stuff.
- CentralNotice/Optimizing_banner_loading Outdated notes and updates.
Proposal
[edit]- Three landing pages and sets of subpages for users in different roles:
- Developers and third-party users How the extension works, how to install, how to contribute, current technical issues and development roadmap. Site:
mediawiki.org. - CentralNotice administrators, community users How to set up campaigns and banners, how to translations work; guidelines and community procedures; not-very-technical overview of how CentralNotice works. Site:
meta.wikimedia.org. - Operations and deployers Details of WMF configuration, caching setup, operations issues, deployment procedures. Site:
wikitech.wikimedia.org.
- Developers and third-party users How the extension works, how to install, how to contribute, current technical issues and development roadmap. Site:
- Each landing page has an overview of CentralNotice, an index of subpages and links to the other landing pages.
- Existing documentation:
- Review for a list of topics that should be covered, so we don't forget anything important.
- Archive or delete out-of-date documentation.
Drafts
[edit]Overview (all landing pages)
[edit]CentralNotice is the Mediawiki extension used to deliver announcements (usually in the form of banners) to WMF wikis. It's used heavily by the Fundraising team to solicit donations, and for announcements of interest to Wikimedia communities and users. CentralNotice can target announcements by country, language, project, device and logged-in status.
[As would appear on mediawiki.org] This page has information for CentralNotice developers and wiki administrators who would like to install CentralNotice on their own sites. To learn how to create or request CentralNotice campaigns and banners, and how to help with translations for banners, please see CentralNotice on meta.wikimedia.org. For information about CentralNotice on the WMF's cluster, see CentralNotice on wikitech.wikimedia.org.