Wikify-fr
De Mi caja de notas
Révision datée du 22 février 2020 à 05:26 par Xtof (discussion | contributions) (→Pourquoi Rejoindre le Wiki IndieWeb)
Cette page a démarré sur iwc:wikifying et sera synchronisée pour traduction sur iwc:wikifying-fr
wikifier désigne la pratique de déposer de l’information et des idées sur le wiki. Par exemple, "Nous avons besoin de wikifier cette FAQ, ce concept, ce jargon, ou cet etherpad".
Suivez les directions étape-par-étape sur cette page pour :
- Étape 1 : Créer votre page wiki.
- Étape 2 : Éditer votre page wiki.
- Étape 3 : (facultatif) vous ajouter vous-même aux noms de discussion
- Étape 4 : (facultatif) créer une sparkline afin qu’il y ait une image à côté de votre nom d’utilisateur
Puis commencez par contribuer sur le wiki.
Pourquoi Rejoindre le Wiki IndieWeb
En tant que communauté, nous évitons les e-mails et préférons discuter en temps réel et de documenter les points importants du wiki pour faciliter la recherche et la création d'informations et de documentation au fil du temps.
Lorsque vous rejoignez le wiki, vous aidez notre communauté à grandir et vous fournissez également la documentation de votre voyage. Cela aide la prochaine personne qui, comme vous, souhaite contrôler ses données dans le lieu qu'elle possède.
Chaque personne qui rejoint le wiki a une page utilisateur qu'elle gère et crée au fil du temps. Vous pouvez façonner votre page pour raconter votre histoire. Au début, tenez compte de ces exemples lorsque vous recherchez des idées.
Exemples IndieWeb
- Tantek Çelik
- Aaron Parecki
- Modèle:GWG
- Modèle:Kylewm
- Ben Werdmüller
- Modèle:Gregorlove
- Chris Aldrich
- Modèle:Jgmac1106
- Modèle:Jamietanna
Pourquoi
Wikifier en général, et notamment des sujets, des notes ou des documents, aide à développer les communs interrogeables et découvrables de la communauté IndieWebCamp.
Est-ce lié à l'IndieWeb ? Super, ajoute-le au wiki. Pas sûr ? Regarde des exemples de ce qu'il faut (ou ne pas) ajouter :
Comment faire
Se wikifier soi-même
Comme beaucoup de choses dans l'IndieWebCamp, commencez par éditer votre votre page, dans ce cas, votre propre page "User:".
Votre page "User:" est liée en haut et à droite au nom de votre domaine que vous avez utilisé pour vous connecter sur le wiki (juste avant "My talk" - ou "Page de discussion" si vous avez réglé vos préférences en français).
Cliquez dessus et éditer votre page User:.
Si vous n'êtes pas sûr quoi poser sur votre page User:, commencez simple. Nom, URL, h-card, par ex.
<span class="h-card">[http://mondomaine.exemple.com/ Votre Nom]</span>
Puis, ajoutez une section "démangeaisons" ou "itches" où vous saisirez ce que vous voulez travailler sur votre propre site, une présence personnelle numérique en ligne, un usage numérique d'un terminal personnel (par ex. même quand vous n'êtes pas connecté). Par ex. :
== Ce qui me démange == * Ajouter une [[h-card-fr|hcard]] complète sur mon site * Imaginer un [[URL design-fr|design URL]] pour mes posts * Commencer à poster manuellement des [[notes-fr|notes]] avec des [[permalinks-fr|permaliens]] * Vérifier mon site avec indiewebify.me * Mesurer mon [[IndieMark-fr|IndieMark]] pour quelques idées supplémentaires à ajouter sur mon site
Quand vous commencez à assembler beaucoup de démangeaisons, vous pourriez vouloir démarrer des priorités, tout spécialement en renseignant ce sur quoi vous travaillez en ce moment. Pour cela, démarrez par une section "Je bosse sur" :
== En train de travailler == * la prochaine chose que je compte travailler sur mon site * la prochaine prochaine chose que je travaillerai .... * ... etc.
Pour finir, regardez les pages d'autres utilisateurs, tout spécialement les personnes qui ont fait ça depuis un moment, afin de voir ce que vous pourriez ajouter à votre page et travailler.
- Tantek Çelik
- Aaron Parecki
- Modèle:GWG
- Modèle:Kylewm
- Ben Werdmüller
- ...
Concentration
Parce que c'est IndieWebCamp, et que ceci traite de votre page utilisateur IndieWebCamp, cela devrait revenir continuellement à vous poser la question :
- Quelle est la prochaine chose que vous voulez travailler sur votre site personnel ?
Ce qui veut dire par exemple que les éléments suivants seront mieux à laisser de côté ou à poursuivre ailleurs - comme sur votre propre site !
- Une todo liste personnelle (d'autres choses sur des sites non personnels) - votre page utilisateur IndieWebCamp est de travailler sur votre site personnel.
- Demander aux autres de faire le travail pour vous. Note : les demandes d'aide pour les démangeaisons/projets spécifiques IndieWeb sont ok, mais adressez-les à tout le monde, pas seulement à des individus. Ceci concerne tout ce que vous voulez travailler - nous pas la délégation à d'autres du travail à réaliser.
- Essayer de faire que les silos fassent des choses, en général ou avec des comptes spécifiques - au lieu de cela, documentez les problèmes de silos individuels sur les pages spécifiques des silos sur le wiki, et suivez-là. Vos démangeaisons devraient concerner votre site personnel, pas les silos.
Wikification Incrémentale
Il y a beaucoup de wikification incrémentale à produire.
- corriger les erreurs de typo
- Ajouter des exemples IndieWeb - si vous trouvez une page pour une technologie que vous soutenez sur votre site, ou un projet que vous utilisez sur votre site, ajoutez-le vous-même à la section «Exemples IndieWeb" pour cette page
- Ajoutez des problèmes et des questions (pour les FAQ)
- Recueillez des questions/réponses de IRC et ajoutez-les à la page wiki appropriée
- Organisez le contenu d'une page qui grandit en la découpant en sections agrandir une page
Nouvelles pages
Il y a beaucoup de création de nouvelles pages, que vous pouvez aider. Créer de nouvelles pages wiki pour :
- de nouveaux concepts ou termes discutés, par exemple dans IRC
- commencer par {{stub-fr}} et une courte définition !
- surtout si elles sont en rapport avec indieweb d'une certaine façon
- les etherpads des notes de sessions IndieWebCamp une fois terminées, pour archiver les notes de session dans un endroit plus trouvable/pointable.
- les nouveaux projets que vous commencez à utiliser sur votre site personnel ; assurez-vous d'ajouter votre site dans la section Exemples IndieWeb sur la page.
Si quelque chose n'est pas lié à indieweb, par exemple ça n'a pas été soulevé dans la discussion comme des choses en rapport avec indieweb, envisagez peut-être de documenter sur Wikipedia à la place (et/ou en utilisant Wikipedia comme une référence/citation).
Documentez vos décisions
Une fois que vous avez vous-même documenté votre page d'utilisateur, et avez commencé à documenter de manière incrémentale vos "Démangeaisons" et "Le travail en cours", au fur et à mesure que vous effectuez le travail et le déploiement sur votre site personnel, documentez vos "grandes décisions" sur votre page d'utilisateur ou peut-être dans une section "Mise en œuvre de la conception" de votre page de projet.
Exemples :
- Falcon#Implementation_Design - major design decisions made in Falcon so far.
Documenter vos grandes décisions de conception et de mise en œuvre vous aidera à mieux considérer quand les revoir, et quand travailler sur de nouvelles fonctionnalités et caractéristiques.
Définir le jargon
Chaque fois que quelqu'un utilise un terme de jargon sur IRC, ou d'autres canaux de communication indieweb, allez-y et demandez dans le canal :
- What is terme jargon
Ceci alertera Loqi qui répondra soit avec la définition du wiki, ou vous alertera pour définir le terme avec un lien pour créer la page sur le wiki.
Vous pourrez ensuite définir le terme jargon en cliquant sur ce lien, ou répondre à la question :
- Un terme jargon est un concept peu évident, ou une ré-utilisation d'un mot pour signifier quelque chose d'autre que son sens commun.
Essayez d'être spécifique et avec du sens dans les définitions, et ajoutez pourquoi c'est pertinent pour l'indieweb (si ce n'est pas évident à partir de la description).
Éviter de répéter les mots du terme, évitez les définitions abstraites génériques, et minimisez l'utilisation de termes du jargon dans une définition (utilisez-les si nécessaire, puis reliez/définissez les aussi).
définitions tweetables
Consultez les définitions sur les pages wiki, et modifiez-les pour qu'elles soient tweetables, car il est démontré que les gens tweeteront les bonnes définitions qui seront d'une longueur tweetable (en y ajoutant un lien à la suite de la page) - ce qui veut dire 116 caractères (espace + 23 caractères pour le lien raccourci tco).
Site deaths are when sites go offline, taking content and permalinks with them, and breaking the web accordingly. http://indiewebcamp.com/site-deaths
- Notez qu'il a édité le dfn de site-deaths (à cette heure) et éliminé "their" afin de l'adapter à Twitter.
Divulgation progressive du contenu
Une définition tweetable (ou minimale) sans jargon simple est une première étape importante dans la fourniture d'un contenu qui soit compréhensible par un public plus large, tout en documentant toutes les recherches et les détails importants qui sont découverts ou inventés par la communauté.
Presque chaque page sur le wiki peut être améliorée à cet égard, afin de fournir une divulgation progressive du contenu pertinent..
Autrement dit, les pages wiki devraient commencer par offrir aux débutants des informations définitives et rapides.
Et ensuite documentez de manière incrémentale les détails si nécessaires pour le vrai monde et les cas d'utilisation qui fournissent des avantages aux lecteurs.
Par exemple Commencer peut (encore) être à cet égard continuellement améliorée. Comme on pourrait le faire avec l'hébergement web.
Articles en Rapport
Ce qui précède est très spécifique à ce qui est une bonne wikification pour IndieWebCamp, en particulier.
Voici les articles liés sur la bonne écriture, la structure et la wikification en général :
FAQ
Est-ce que cela devrait aller sur le wiki
Q : Avons-nous vraiment besoin de ça sur le wiki ?
R : Cela dépend ! En bref, tout ce qui concerne l'indieweb vaut la peine d'être posé sur le wiki, et bien sûr c'est à quelqu'un de prendre soin de le faire !
Voici quelques bons exemples de choses à mettre sur le wiki :
- Tout sujet directement lié à l'IndieWeb, en particulier directement lié aux personnes dans la communauté avec leurs propres sites :
- Technologies (par exemple Apache) les gens l'utilisent pour installer/construire/faire tourner/maintenir/surveiller leur site indieweb
- Les services (par ex. l'hébergement web) que les gens utilisent pour leur site indieweb
- Les événements ou podcasts qui discutent du web indépendant ou de l'IndieWeb en particulier, y compris les événements avec une seule conversation connexe (assurez-vous d'inscrire le discours spécifique)
- Le Jargon représentant une technologie utilisée dans le cadre d'un site IndieWeb
- Les silos qui ont l'art et l'antécédent (UX, design, formats, protocoles) pour les choses que nous voulons reconstruire indépendamment.
- Aussi tous les silos où tout le monde s'attend (ou devrait/est sur le point) à perdre du contenu, des permaliens, des identités en ligne.
Qu'est ce qui ne devrait pas aller sur le wiki
Q: Si tout cela a du sens sur le wiki, qu'est-ce qui n'a pas de sens sur le wiki ?
R : Il y a tellement de choses qui ne nécessitent pas d'être sur le wiki qu'il est difficile de les énumérer toutes. De toute évidence, en dehors des choses comme les violations du code-de-conduite, voici quelques-unes que nous avons vu être ajoutées et décidé que ce serait mieux de les enlever. Ces choses semblent tomber dans le modèle-type de quand quelqu'un est passionné par quelque chose qui n'est pas lié à l'indieweb, et veut l'ajouter au wiki.
- Les choses aléatoires. En général, les choses aléatoires qui ne disposent pas d'une connexion IndieWeb évidente sont mieux à déposer sur Wikipedia, et en utilisant les liens de Wikipedia plutôt que de créer des pages d'ébauches moins utiles sur le wiki IndieWeb. Par exemple.
- Les termes techniques. Si un terme technique n'a pas de lien évident direct avec IndieWeb, pas besoin de le documenter ici.
- Les organisations. Si une organisation n'a aucun rapport avec quoi que ce soit d'indépendant, elle peut probablement être laissée de côté.
- Exception : Comme indiqué ci-dessus sous les silos, nous documentons tout/tous les sites/services que tout le monde a utilisé dans la communauté (ou même si des amis l'ont utilisé) qui ont annoncé ou sont menacés de fermeture, ou s'il a en particulier une UX qui vaut d'être capturée à des fins de recherche pour designer nos propres fonctionnalités indieweb.
- événements. Si un événement n'a rien à voir avec l'indieweb, il n'a pas besoin d'être inscrit sur la page événements.
Discussion IRC en rapport :
Voir aussi
wikifying is the practice of capturing information and ideas on the wiki. E.g. "We need to wikify that FAQ, concept, jargon, or etherpad".
Follow the step by step directions on this page to:
- Step 1: Create your wiki page.
- Step 2: Edit your wiki page.
- Step 3: (optional) add your self to chat-names
- Step 4: (optional) create a sparkline so there is a picture next your user name
Then begin to contribute to the wiki.
Why Join the IndieWeb Wiki
As a community, we eschew email in lieu of real-time chat and documentation of the important points on the wiki to make it easier to search and build information and documentation over time.
When you join the wiki you help our community grow and also provide documentation of your journey. This helps the next person who, like you, wants to control their data in the place that they own.
Each person who joins the wiki has a user page they maintain and build over time. You can shape your page to tell your story. As you get started please consider these examples as you look for ideas.
IndieWeb Examples
- Tantek Çelik
- Aaron Parecki
- Modèle:GWG
- Modèle:Kylewm
- Ben Werdmüller
- Modèle:Gregorlove
- Chris Aldrich
- Modèle:Jgmac1106
- Modèle:Jamietanna
How to Join the IndieWeb Wiki
If you have not done so already, set up web sign-in on your domain. Unlike other sites where you choose a username and password, you only need your domain name to log in to this wiki.
Step One: Create your user page
After logging in, visit your user page. Then click Create. You can choose two templates to add a profile to your page.
- Minimum Profile
- Infobox Profile
If you want to edit your page at a later date go to your own user page (or click your domain name at the top right). From there, click Edit.
Minimum Profile
The IndieWeb community uses h-cards to identify people online. This is like a business card for your website.
The smallest h-card includes your name and a link to your website.
<span class="h-card">[http://example.com/ Your Name]</span>
Infobox Profile
If you would like to include a profile box like Aaron Parecki for example, we have created a template for you.
Go to Infobox person and copy the template. Then return to your user page. Paste the template on your user page. Fill out the relevant data you'd like to display, then save the page.
Step Two: Edit Your Wiki page
You can shape your wiki page any way you like. There are some common elements many community members include:
Write down your itches
Next, add an itches section where you capture what you want to work on for your own site, personal online digital presence, and personal digital device usage (e.g. even when offline) in general. E.g.
== Itches == * Add a more extensive [[h-card]] on my site * Figure out a [[URL design]] for my posts * Start posting [[notes]] manually at [[permalinks]] * Try checking my site in indiewebify.me * Check out [[IndieMark]] for additional ideas of things to add to my site
When you start collecting lots of itches, you may want to start prioritizing them, especially by what you're currently working on. Start a "Working on" section for that:
== Working On == * the next thing I'm working on for my site * the next next thing I'm working on getting working on my site * ... etc.
Focus
As this is the IndieWeb, and this is about your IndieWeb user page, it should be about answering this question, continuously:
- What is the next thing you want to get working on your personal site?
This means for example that the following are better left out and pursued elsewhere - like on your own site!
- A personal to do list (of other non-personal-site things) - your IndieWeb user page is about work on your personal site.
- Asking others to do work for you. Note: requests for help with IndieWeb specific itches/projects are ok, but address them to everyone, not just individuals. This is about what you want to work on - not asking others to do work.
- Trying to get silos to do things, in general or with specific accounts - instead, document individual silo issues on the specific silo wiki pages, and follow-up there. Your itches should be about your personal site, not silos.
Additional Templates
These pre-defined wiki templates that can be added to a user page:
- Infobox template: Template:Infobox_person
- Twitter template: Template:twitter-link
- Facebook template: Template:facebook-link
- Mastodon template: Template:mastodon-link
Step Three: Add a chat name
Optionally add yourself to chat-names. This will show your photo by your name in the chat logs and link your name to your website. It will also allow our friendly chat bot Loqi to answer "who is [username]" with information from your wiki user page.
To add a chat name visit chat-names and use the provided template.
Step Four: Add a sparkline
The IndieWeb wiki allows sparklines, a small avatar that contains your photo and your name linked to your user page. This means people can add
{{yourname}}
to any page and a link with your picture will display.
Visit the template to add a sparkline.
Why Contribute to the IndieWeb Wiki
Wikifying both in general, and particular subjects, notes, or documents, helps grow the searchable & discoverable commons of the IndieWeb community.
Is it IndieWeb related? Great, add it to the wiki. Not sure? See examples of what (not) to add:
How to Contribute to the IndieWeb Wiki
Finding pages that need improvement
If you're looking for a way to help improve the wiki, consider looking for old pages and help clean them up and improve them! The sections below describe ways you can improve pages, such as fixing typos, ensuring pages have some sort of IndieWeb relevance, adding citations, or even deleting a page.
Here are some ideas for how to find pages that are likely to need improvement.
- Pages with the Fewest Revisions - These are pages likely to have been defined in chat and need to be expanded. (You can ignore the "redirect pages" in this list.)
- Short Pages - These pages have very little text. Sometimes that's because a redirect was created incorrectly, or sometimes the page was defined in chat and never expanded.
- Oldest Pages - This is a list of pages sorted by the oldest date since the last edit. They are likely to have stale information, or may not meet our current standards for wiki pages if they were created many years ago.
- Lonely Pages - These pages are not linked to by any other page. If the page is relatively complete itself, then consider adding links to it from relevant pages it may link to.
Incremental Wikifying
There's lots of incremental wikifying to help with.
- fixing typos
- expanding (and/or simplifying) a definition to include the IndieWeb relevance of the term
- adding IndieWeb Examples - if you find a page for a technology you support on your site, or a project you use on your site, add yourself to the "IndieWeb Examples" for that page
- add issues and questions (for FAQs)
- collect questions/answers from chat and add them to the appropriate wiki page
- organize the content of a growing page into sections per expand a page
See:
- expand a page for many more specific suggestions for incremental wikifying.
- to-do for specific wiki pages that need incremental improvements!
Add Citations
Whenever you see Loqi (or anyone frankly) share or post a link in chat to something relevant to the indieweb, please help out by adding those as citations/examples to the wiki, and especially if they're photos, add them to event page(s).
Format citations
Here's how to "text format" citations to add them, from a minimum, to incrementally doing more work (or improving existing citations!)
- link
- seriously, it's ok to just add a link, that's helpful!
- YYYY-MM-DD link
- adding the article's publication date helps a lot by placing the link in a temporal context
- YYYY-MM-DD [link article-name]
- even better, go get the article name which is likely more readable/understandable/searchable/discoverable than the link. Is it a tweet link or lacking a name? Pick a summary sentence instead.
- YYYY-MM-DD author: [link article-name]
- even better, add the author to help provide authority or at least the context of who-from
- YYYY-MM-DD {{indiewebauthor}}: [link article-name]
- even better, if the author is a participant in the indieweb community use the {{}} template for their shortname / chat nickname to link their name, perhaps even provide their icon automatically
Optionally:
- Add a
blockquote
inline at the end of the citation, with key relevant sentence(s) copy/pasted/quoted from the link, like this:
YYYY-MM-DD [link article-name] <blockquote>key relevant sentence(s)!</blockquote>
These are all super-easy (nearly completely) plain-text ways of just pasting/typing the information into the wiki. (Nearly) No code or markup to learn or figure out or debug. Don't worry about not being perfect, others can help with tweaking fixing things.
Keeping wiki pages mostly plain-text-like makes them easier for others to edit and improve as well!
The important thing is to just take the step of adding the information.
If you like or are familiar MediaWiki templates, you can also use:
Where to add a citation
If you don't know where in a page to put a citation, add it to the See Also section at the end.
- You can even do this from chat by using the << trick like this:
wikipagename << YYYY-MM-DD [link article-name]
etc.
If the citation is criticism, add/move it to the Criticism section of the article.
These are all incremental steps. None are required. All are something you can help with.
Every incremental step you can help with above helps the wiki.
Even just one incremental improvement is helpful!
New pages
There's lots of new page creation you can help with. Create new wiki pages for:
- new concepts or terms being discussed, e.g. in chat
- start with {{stub}} and a short definition that includes its indieweb relevance! (see next section)
- especially if they're indieweb-related in some way
- etherpads of notes from IndieWebCamp sessions after they're finished, to archive the session notes somewhere more findable / linkable
- new projects you start using on your personal website; be sure to include your site in the IndieWeb Examples section on the page.
If something is not particularly indieweb-related, e.g. it didn't come up in the discussion of things that are indieweb-related, perhaps consider documenting it on Wikipedia instead (and/or using Wikipedia as a reference/citation).
Definitions include indieweb relevance
When defining a term, include why it is specifically relevant to the indieweb (if that's not obvious from the description), beyond just a "normal" definition that could have come from Wikipedia (no need to replicate or summarize Wikipedia here, and do not copy from Wikipedia, instead link to it).
E.g. the jargon example could be improved with indieweb relevance like:
- A jargon term is a specific unobvious word, concept, or technology (like Webmention), or re-use of a word to mean something other than its common meaning (like feed), or sometimes re-using a word as an acronym (like POSSE).
Document your decisions
Once you've documented yourself on your User page, and started incrementally documenting your "Itches" and "Working On", as you get work done and deploy to your personal site, document your "major decisions", on your user page or perhaps in a "Implementation Design" section on your project page.
Examples:
- Falcon#Implementation_Design - major design decisions made in Falcon so far.
Documenting your major design and implementation decisions will help you better consider when to revisit them, and when to work on new personal site features and functionality instead.
Define jargon
Any time someone uses a jargon term in chat, or other indieweb related communications, go ahead and ask in the channel:
- What is jargon term
This will prompt Loqi to either answer with the definition with the wiki, or to prompt you to define it with a link to create the page on the wiki.
You can then define it by clicking on that link, or answer answer the what is question:
- A jargon term is a specific unobvious concept, or re-use of a word to mean something other than its common meaning.
Avoid repeating words from the term, avoid generic abstract definitions, and minimize use of jargon terms in a definition (though use them if necessary, and then link/define them too).
Be specific and meaningful in definitions, certainly more than just a link and/or restatement using the same or similar terms.
Tweetable definitions
Check the definitions on wiki pages, and edit them so they are tweetable, as there is evidence that people will tweet good definitions that are of tweetable length (including a subsequent link to the page) - that's 257 characters (space + 23 characters for the tco'd link).
- https://twitter.com/zeldman/status/688791904356581376
Site deaths are when sites go offline, taking content and permalinks with them, and breaking the web accordingly. http://indiewebcamp.com/site-deaths
- Note that he edited the dfn of site-deaths (as of that time) and removed "their" in order to make it fit on Twitter.
Progressive disclosure of content
A simple jargon-free (or minimal) tweetable definition is an important first step in providing content that is understandable by a broader audience, while still documenting all the important research and details that are discovered or invented by the community.
Nearly every page on the wiki can be improved in this regard, to provide progressive disclosure of relevant content.
That is, wiki pages should start with offering quick, definitive information to a beginner.
And then incrementally document details only as needed for real world reasons / use-cases that provide benefits to those reading.
E.g. getting started can (still) be continuously improved in this regard. As can web hosting.
Common Page Structure
Most pages on the wiki have evolved to have a fairly common page structure, starting with a simple definition, and then adding additional sections such as:
- Why
- How to
- IndieWeb Examples
- Brainstorming
- See Also
For more details on these and more, see:
Special Case Pages
In addition to the common structure across many pages, there are also several clusters or instances of special case pages.
Standards Pages
The wiki has pages for standards / specifications that were developed on the indieweb wiki, and have started or been formalized at W3C, and thus their pages (and subpages) here have evolved in support of those specifications.
While these are rapidly evolving, take a look at:
There are also pages that are about the indieweb usage of standards developed elsewhere or in active collaboration across communities, e.g. the pages for various microformats. Though these are generally structured in the common structure noted above, they may as a set have special patterns worth noting:
(stub) - help expand this section with documentation of patterns across this type of special page.
Historical Pages
Some pages help document history, e.g.:
(stub) - help expand this section with documentation of patterns across this type of special page.
Cross-Generation Pages
As certain IndieWeb building-blocks become more widespread, folks from later generations could benefit from re-organized content. In some cases, it may be beneficial to break out "introductory" content (including high-level explanations, examples with screenshots, tools and services, ...) from "developer" content (such as protocol diagrams, code snippets, brainstorming, ...) For example:
- Webmention is an introduction page, with developer-specific content moved to Webmention-developer.
(stub) - help expand this section with documentation of patterns across this type of special page.
Related Articles
The above is very much specific to what is good wikifying for IndieWeb in particular.
Here are related articles on good writing, structure, and wikifying in general:
FAQ
Should this be on the wiki
Q: Do we really need this on the wiki?
A: Depends! In short, anything indieweb related is worth putting on the wiki, and sure it's up to someone to care enough to do it!
Here are some good examples of stuff to put on the wiki:
- Anything directly IndieWeb related, especially directly to people in the community with their own sites:
- Technologies (e.g. Apache) people are using to setup/build/run/maintain/monitor their indieweb site
- Services (e.g. web hosting) people are using with their indieweb site
- Events or podcasts that discuss the independent web or IndieWeb in particular, including events with only a single related talk (be sure to list the specific talk)
- jargon representing technology used as part of an IndieWeb site
- silos that have prior art (UX, design, formats, protocols) for things we want to rebuild independently
- also any silos where anyone has or is about to / expected to lose content, permalinks, online identities.
- If you are unsure just ask in our #meta channel. If you prefer to ask the question off the record where it is not logged you can try the #chat channel (See Discuss).
What should not go on the wiki
Q: If all that makes sense on the wiki, what does not make sense on the wiki?
A: There are so many things that do not need to be on the wiki that it's hard to list them all. Obviously aside from stuff like code-of-conduct violations, here are a few which we've seen added then decided were better removed, that seem to fall into the pattern of when someone is passionate about something totally not indieweb related, and wants to add it to the wiki.
- Random stuff. In general, random things that lack an obvious IndieWeb connection are better left to Wikipedia, and using Wikipedia links rather than creating less useful stub pages on the IndieWeb wiki.
- Technical terms. If a technical term does not have a direct obvious connection to the IndieWeb, no need for it to be documented here.
- Organizations. If an organization has no relation to anything IndieWeb it can be left out.
- Exception: As noted above as silos, we are documenting any/all sites/services that anyone in the community has used (or even has friends that have used) that has announced or is threatening to shut down, or has especially has UX that is worth capturing for prior art research purposes when designing our own indieweb features.
- Events. If an event has nothing to do with the indieweb, it does not need to be listed on the Events page.
Once again ask in chat. People will help you determine the relevancy of a topic, link to previous discussions in the logs, or point you to an existing page where the date are previously captured.
For all of these, consider instead adding them to Wikipedia (or expanding their articles there instead).
Do I have to use the wiki and mediawiki syntax?
While it's nice to put content into the wiki using standard markup for it, we realize not everyone is a wiki fan, knows how to do it, or even may have the time to learn to do it. (Documenting what you've done is both important and work enough.)
- Alternative: Post on your own site with CC0! An alternate option is to simply practice the Indieweb principle of posting on your own site first where you have ultimate control. Then webmention "Indieweb" (for Superfeedr) or dump the link into chat. As long as you license your content as CC0 for that post, someone will surely add it to the wiki on your behalf.
- Just add content, with double linebreaks for paragraphs! Users shouldn't feel guilty for adding content as best as they can (markup/formatting or not) where they feel it's appropriate. Others will come along and clean bits up in the near future. Nor should they hesitate to ask for help in chat if they'd like to learn more about wikifying.
Related chats:
- https://chat.indieweb.org/2016-05-20#t1463775866966000
- https://chat.indieweb.org/dev/2017-06-18#t1497799332968000
Where should I add something to the wiki?
When you see an IndieWeb related article, post, concept, and want to add it to the wiki, it may not be obvious where to add it, even just as a "See Also". Here are some tips for where to add something:
- An existing page it is most relevant to.
- If there are a couple of pages (e.g. maybe a general concept like privacy, and a specific silo like Facebook), it’s ok to add it to both.
- If you can think of a few different related pages, then create a new stub page for it, and then add a link to that stub page in the See Also sections of those related pages