Partkeepr: Wiki Partkeepr

Créé le 12 avr. 2019  ·  26Commentaires  ·  Source: partkeepr/PartKeepr

Pas directement lié à la base de code - mais le wiki Partkeepr n'est plus disponible sur
https://wiki.partkeepr.org/
Je ne sais pas si cela a été archivé quelque part, mais cela a été une ressource très utile et j'aimerais le voir restauré, si possible.

meta

Commentaire le plus utile

Il semble que le wiki soit de nouveau en ligne.

Tous les 26 commentaires

Pour l'instant, la seule chose que j'ai réussi à faire "fonctionner" est d'utiliser les pages mises en cache par Google. Vous recherchez simplement une page wiki pertinente, google affiche un résultat, puis au lieu de cliquer sur le lien lui-même, cliquez sur la petite flèche vers le bas à côté, puis cliquez sur mis en cache. Ce sera sans style mais le contenu est là. Ou allez en utilisant archive.org : http://web.archive.org/web/20180310044536/http://wiki.partkeepr . org:80/wiki/Page_principale

J'espère qu'à un moment donné, le wiki reviendra, même si ce n'est que sous forme de code html nu dans un dossier sur github (ou dans l'onglet wiki ici).

Il semble que le wiki soit de nouveau en ligne.

Excellente nouvelle! Fermeture.

Quoi qu'il en soit, est-ce que quelqu'un sait où est hébergé le wiki ? Est-ce toujours de la responsabilité de @Drachenkaetzchen ? Dans un autre numéro, le problème de Partkeepr qui a été un peu bloqué pour le moment est décrit. Cela pourrait être un bon moyen d'aider @Drachenkaetzchen et d'en assumer la responsabilité sur d'autres épaules. Ensuite, une sauvegarde du Wiki/SQL est nécessaire.

@Gasman2014 Dans l'ensemble, je voterais pour rouvrir jusqu'à ce que ce problème soit résolu à long terme.

Je suis avec @christianlupus , je dirais plutôt l'héberger dans la section wiki de githubs, cela devrait alléger une partie de la charge des serveurs et des épaules de

Compte tenu de l'opportunité d'une solution à plus long terme et des suggestions de @C44Supra et @christianlupus pour essayer de soutenir Felicia @Drachenkaetzchen en archivant ces données et en les hébergeant indépendamment via github, je rouvre ceci. Les informations du wiki sont très utiles pour dépanner les installations - en particulier dans des situations de niche non décrites dans le guide de configuration principal. Ces informations doivent être disponibles avec la base de code pour une convivialité maximale. Je suis très heureux de voir que le wiki a été restauré mais peut-être qu'il pourrait sans trop de travail être combiné avec la section wiki github qui contient également des informations utiles mais supplémentaires et différentes.

Si quelqu'un peut fournir un moyen de déplacer automatiquement le wiki hébergé vers GitHub, veuillez me le faire savoir, mais seulement si vous avez réellement testé un tel mécanisme. Un simple google donne de nombreux résultats pour un tel mécanisme, et je n'ai ni le temps ni l'énergie pour les étudier.

Si vous avez besoin d'une sorte d'accès API pour le wiki actuel ou un dump de base de données, faites-le moi savoir.

Je serais prêt à essayer de préparer ça. Je vais essayer de migrer vers un wiki dans mon compte personnel. Pour autant que je l'ai vu, je ne peux migrer que la dernière version du wiki et quelques ajustements manuels sont nécessaires.

J'ai essayé de migrer les fichiers wiki vers github. Le résultat est visible dans ce repo . Certaines modifications mineures sont encore nécessaires (comme supprimer les fautes de frappe, renommer les pages, organiser les fichiers, etc.).

Malheureusement, l'exportation automatique vers XML (méthode standard d'exportation depuis mediawiki) présente certains inconvénients. De cette façon, l'historique des pages est perdu et aucun fichier multimédia n'est exporté. Je les ai téléchargées manuellement mais les métadonnées (comme le titre et le texte alternatif) n'ont pas été portées. De plus, le wiki de github est un peu plus restreint que Mediawiki, ce qui rend, par exemple, les listes de sous-pages impossibles à ma connaissance.

@Drachenkaetzchen Je vous demanderais de vérifier que le wiki peut être utilisé de cette façon. Ensuite, vous pouvez simplement installer les pages de mon dépôt sur la page Partkeepr si cela vous convient. Contactez-moi en cas de questions, je serais très heureux et fier de vous aider.
PS : je vous ai ajouté en tant que collaborateur au dépôt pour que vous puissiez jouer avec.

Tous les autres sont invités à parcourir le wiki à la recherche d'erreurs que j'ai manquées.

@Drachenkaetzchen Je vous demanderais de vérifier que le wiki peut être utilisé de cette façon.

Je suis confus, que dois-je vérifier exactement ?

J'ai porté le wiki sur github. Veuillez vérifier si ce travail est acceptable selon vos normes de qualité et je n'ai pas complètement foiré.

Je pense que vous devriez demander aux utilisateurs ;) J'utilise rarement le wiki.

Je suggère de demander des commentaires sur la liste de diffusion

J'ai laissé un message sur la liste de diffusion . Renvoyé ici uniquement pour l'achèvement.

Je suggère que nous utilisions des pages github au lieu d'un wiki github. Nous aurions plus d'options concernant l'organisation des fichiers là-bas et il n'y a pas de grande différence entre les deux solutions. Existe-t-il des options auxquelles un wiki github pourrait être mieux adapté ?

@Drachenkaetzchen Je n'ai pas reçu beaucoup d'attention et de réponse des autres utilisateurs concernant la migration du wiki. Avez-vous un horaire ou comment procéderions-nous ici? Je préparerais la migration en termes de fonctionnement des liens et des noms de fichiers utiles. Comme il s'agit d'un travail manuel, je préférerais ne pas le faire, lorsqu'il n'est pas utilisé plus tard.

Je ne peux vraiment pas donner de retour. Je ne peux faire que des trucs d'administration pour le projet.

OK, alors je demande à @dromer de donner son avis.

Salut à tous, je n'ai vu aucune discussion sur la migration du wiki vers github.

Je pense qu'il est logique de concentrer toutes les informations dont nous disposons dans une seule ressource. Mais les informations sur lesquelles nous migrons doivent également être pertinentes et supprimées des éléments hérités.

Mon expérience avec le wiki et les pages github est pratiquement inexistante, donc je ne peux pas vraiment commenter là-dessus.

[modifier : ah les pages seraient comme un site jekyll ou quelque chose du genre. une préférence pour un autoformater alors ?]

ah les pages seraient comme un site jekyll ou quelque chose.

Ouaip, c'est à peu près ça. Le wiki d'ailleurs aussi. La différence est que les pages sont destinées à être utilisées pour un site tandis que le wiki pour un ensemble approximatif de morceaux d'informations plus ou moins courts qui ne sont pas triés/organisés. Cela m'a causé (lors de mon premier test de migration) quelques problèmes car les noms de fichiers sont automatiquement devinés par le serveur sous-jacent, par exemple la sensibilité à la casse a causé des problèmes.

Que veux-tu dire par ta phrase

une préférence pour un autoformater alors?

Tu veux dire le style/la mise en page ?

Désolé je voulais dire le générateur de site. Je pense que les pages github peuvent utiliser d'autres que jekyll ?

Je ne suis pas sûr que jekyll soit le moyen le plus simple/le plus agréable d'organiser un wiki, quel serait exactement l'avantage par rapport au wiki github ?

Je ne pense pas que nous devrions nécessairement héberger le site Web principal de partkeepr pour l'instant, concentrons-nous sur des ressources d'information à jour comme le wiki.

Il y a aussi des pages fragmentées sur le wiki github, je pense. Tout cela doit être convergé avec uniquement des informations pertinentes et correctes pour l'état actuel du projet.

Désolé je voulais dire le générateur de site. Je pense que les pages github peuvent utiliser d'autres que jekyll ?

Aucun problème. Peut-être que je ne l'ai pas encore complètement résolu.

Je ne suis pas sûr que jekyll soit le moyen le plus simple/le plus agréable d'organiser un wiki, quel serait exactement l'avantage par rapport au wiki github ?

Eh bien, la différence est mineure pour être honnête, pour autant que je le vois. Les deux prennent le markdown (ou tout autre format que pandoc peut lire) et le formatent de manière agréable.
J'ai trouvé le problème, que le wiki n'autorise pas les espaces de noms et que le mappage entre les liens et le nom de fichier correspondant est en quelque sorte heuristique :

  • Le wiki contient deux pages qui ne diffèrent que par leurs titres ( 1 , 2 ). J'ai dû supprimer manuellement l'un d'entre eux pour que l'heuristique sélectionne le bon.
  • Les sous-dossiers (utilisés comme une sorte d'espacement de noms) ne peuvent être créés que lors de la vérification à l'aide de git manuellement. Les liens ne respectent pas cet espacement de noms donc vous ne pouvez avoir qu'une seule fois chaque nom de fichier, ce qui rend la structure des dossiers contre-pratique. Je ne sais pas comment github sélectionne la page à nommer au cas où deux fichiers auraient le même nom.

Un avantage supplémentaire de la solution github Pages est que vous pouvez exécuter jekyll localement pour vérifier l'apparence et tous les liens sans publier encore. Aussi, je pense que vous pourriez faire plus de style (mais je devrais vérifier cela).

Je ne pense pas que nous devrions nécessairement héberger le site Web principal de partkeepr pour l'instant, concentrons-nous sur des ressources d'information à jour comme le wiki.

Non, je pense que c'est situé pour le moment à un bon emplacement.
Bien que je puisse vouloir souligner qu'il y avait (?) L' idée d'utiliser github pour la page d'accueil principale. Si le besoin s'en fait sentir, on pourrait migrer vers github (si la situation financière de Drachenkaetzchen s'aggrave donc elle a des problèmes pour payer le serveur).

Le but de ce problème est de préserver le wiki actuel au cas où les serveurs tomberaient en panne.

Il y a aussi des pages fragmentées sur le wiki github, je pense. Tout cela doit être convergé avec uniquement des informations pertinentes et correctes pour l'état actuel du projet.

Oui et non. Il doit être lié à la version la plus récente du logiciel. Cependant, je pense que la documentation est relativement faible dans le projet. Je sais que nous manquons de main-d'œuvre, mais sans documentation, les utilisateurs ont plus de problèmes pour voir comment fonctionnent les fonctionnalités du logiciel.
Je m'engage donc à mettre à jour les documents vers la version la plus récente, mais en gardant par exemple les guides de migration des états plus anciens, néanmoins ceux-ci concernent des versions très obsolètes depuis un certain temps (peut-être en divisant certaines pages pour les rendre plus lisibles).

J'espère que nous obtiendrons une certaine traction dans la communauté (vous pourriez rire de ma pensée optimiste) qui vous aidera en ajoutant des trucs et astuces sur la façon de configurer les choses. Au cours des derniers jours, lorsque j'ai travaillé sur les anciens problèmes, j'ai vu pas mal de bonnes idées de la part des membres de la communauté, qui pourraient valoir la peine d'être mentionnées dans une page de type wiki.

Je suis content de toute façon... mais avoir un mainteneur serait une bonne idée... mon expérience est que ces choses vieillissent vite

C'est vrai. Vous voulez dire une personne uniquement dédiée à la mise à jour de la documentation ?

Je serais d'accord pour aider le projet de cette manière aussi. Ne me comprenez pas mal : je n'insiste pas dans cette position. Il doit être décidé par consensus.
Pour le moment, il n'y a pas beaucoup de nouveautés à documenter. Principalement la mise à jour de l'existant. Cela pourrait changer si le projet reprend du poil de la bête et qu'un nouveau code est écrit/modifié. Ensuite, le mainteneur de la documentation dépend du support des développeurs dans le sens où le gestionnaire n'est pas capable de comprendre tous les détails techniques.

J'ai un peu plus d'énergie aujourd'hui, alors voici quelques réflexions :

  • Le wiki actuel rend difficile pour les gens de contribuer à la documentation car j'ai dû désactiver l'enregistrement, m'obligeant à créer manuellement des utilisateurs
  • Le wiki intégré à GitHub rend la navigation difficile, surtout s'il y a de nombreuses pages qui ne sont pas correctement liées à partir de la page principale.
  • Il doit être facile de contribuer à la documentation. De préférence où les utilisateurs peuvent simplement cliquer sur un bouton « Modifier la page » pour modifier le contenu existant et sur un bouton pour créer un nouveau contenu. Un exemple que j'aime peut être trouvé ici : http://marlinfw.org/docs/configuration/configuration.html - les modifications entraîneront une demande d'extraction afin qu'elle puisse être examinée et correctement liée par un responsable de la documentation
  • Cependant, dans l'exemple précédent, il n'y a pas de bouton "Nouvelle page", je ne sais pas comment cela pourrait être fait
  • Le wiki actuel rend difficile pour les gens de contribuer à la documentation car j'ai dû désactiver l'enregistrement, m'obligeant à créer manuellement des utilisateurs

C'est en quelque sorte une contradiction avec un wiki mais je comprends les besoins.

  • Le wiki intégré à GitHub rend la navigation difficile, surtout s'il y a de nombreuses pages qui ne sont pas correctement liées à partir de la page principale.

C'est parfaitement vrai. Je ne trouve pas très esthétique la façon dont le wiki est construit. Il faut s'assurer qu'il existe un réseau fin de liens à travers le wiki afin de simplifier la navigation.

  • Il doit être facile de contribuer à la documentation. De préférence où les utilisateurs peuvent simplement cliquer sur un bouton « Modifier la page » pour modifier le contenu existant et sur un bouton pour créer un nouveau contenu. Un exemple que j'aime peut être trouvé ici : http://marlinfw.org/docs/configuration/configuration.html - les modifications entraîneront une demande d'extraction afin qu'elle puisse être examinée et correctement liée par un responsable de la documentation
  • Cependant, dans l'exemple précédent, il n'y a pas de bouton "Nouvelle page", je ne sais pas comment cela pourrait être fait

Ils utilisent la fonctionnalité des pages github mais dans une configuration plus élaborée que celle de base. Je n'ai pas encore tout compris mais je peux me renseigner...

Un utilisateur est activement collecté des informations dans un WIKI local qui est partagé sur https://readthedocs.web.cern.ch/display/PARTK
Il a proposé de transférer ces informations vers un emplacement différent, mais les conseils de l'équipe du projet sont demandés. Le fil pour cela peut être trouvé dans les groupes Google PartKeepr https://groups.google.com/g/partkeepr-users/c/ehqapXqyY0o/m/1VWkA00dDAAJ

Cette page vous a été utile?
0 / 5 - 0 notes

Questions connexes

FinalHopee picture FinalHopee  ·  32Commentaires

WickedAx picture WickedAx  ·  11Commentaires

christianlupus picture christianlupus  ·  55Commentaires

baradhili picture baradhili  ·  17Commentaires

gfarcas picture gfarcas  ·  20Commentaires