18f.gsa.gov: Améliorer le processus de conversion gdoc-to-markdown

Créé le 25 janv. 2017  ·  23Commentaires  ·  Source: 18F/18f.gsa.gov

Lorsqu'un article de blog est terminé, approuvé et prêt à être publié, il doit être converti en démarque pour le site. Ce processus est documenté ici, mais il est très cahoteux.

Points douloureux actuels :

  • tous les liens sont en italique
  • les signes dollar ne sortent pas comme des signes dollar
  • les listes où un élément fait plus d'une ligne se révèlent sous forme de guillemets
  • si vous utilisez des styles personnalisés dans un document Google (c'est-à-dire des en-têtes orange), certains liens apparaissent sous forme de références de fichiers de police au lieu de liens
  • les titres ne sont pas fiables
  • le frontmatter va bien, mais les gens sont mauvais pour le taper correctement
  • les images ne s'affichent pas

    • devez exporter gdoc en tant que page Web, puis extraire les images et les rajouter manuellement

  • des extraits de code sont mutilés
  • ajouter un espace entre les éléments de la liste
Parking lot blog-feature

Commentaire le plus utile

@awfrancisco Lorsque nous parlerons ensuite, je souhaite poser des questions sur le flux de travail global du blog et s'il existe des opportunités en amont d'améliorer ce processus (comme écrire en markdown dans gdocs) - comprendre l'ensemble du processus m'aidera à comprendre un peu mieux ce que nous pouvons /ne peut pas changer.

Tous les 23 commentaires

Notez que ces bogues sont produits lorsque nous utilisons pandoc . Trouvez les problèmes de pandoc ouverts ici .

@elainekamlley @gboone a-

Voici une liste de toutes les choses que je recherche - quand je me souviens.

Le numéro 6 dans cette liste est une autre façon de saisir les images.

En outre, il convient de noter que ce script fonctionne très bien pour exporter des documents Google directement vers Markdown. C'est un peu fastidieux de le faire fonctionner à chaque fois, mais il est possible que je ne le fasse pas correctement.

Les scripts semblent être une bonne option à explorer - cette variante semble également prometteuse.

Avez-vous une estimation du temps que cela prend actuellement pour de simples articles de blog ? Pour des articles plus complexes ?

Plus d'informations! L'utilisation de Pandoc via odt au lieu de docx semble résoudre certains des problèmes, en particulier le formatage étrange de la liste.

Je soupçonne que bon nombre de ces problèmes sont introduits dans la partie GDocs -> Word du processus, plutôt que dans l'étape Word -> markdown, donc je pense que nous devrions explorer les moyens de supprimer l'étape intermédiaire.

Ce script Google a-t-il été essayé comme alternative à pandoc ? Je l'ai essayé tout à l'heure et cela a semblé résoudre certains des problèmes, mais a mutilé le frontmatter.

Le convert to markdown --> check email --> amend any errors serait-il un nouveau workflow acceptable, ou est-ce encore pire qu'avant ?

Oups ! J'aurais dû lire ce fil avant de poster. On dirait que cette option a été/est en train d'être explorée 😀

@gboone en saurait plus, mais je pense que soit nous ne sommes pas autorisés à utiliser les scripts Google, soit vous devez les réinstaller pour chaque document. Il y a un lourd fardeau qui en fait une sorte de douleur.

J'ai soumis le formulaire de vérification OCIO pour au moins un des scripts Google, pour voir si ce processus peut être exécuté. Espérons que si cela fonctionne, cela nous donnera la possibilité d'utiliser à nouveau ce script.

Oui, la description de @awfrancisco correspond à mon expérience - je devrais réinstaller le script chaque fois que je voulais l'utiliser. Je ne connaissais pas ce formulaire pour les faire approuver, mais j'ai ouvert il y a longtemps un problème au service d'assistance informatique à ce sujet qui est resté largement sans réponse. Croisons les doigts pour que la forme fonctionne pour nous.

@awfrancisco Lorsque nous parlerons ensuite, je souhaite poser des questions sur le flux de travail global du blog et s'il existe des opportunités en amont d'améliorer ce processus (comme écrire en markdown dans gdocs) - comprendre l'ensemble du processus m'aidera à comprendre un peu mieux ce que nous pouvons /ne peut pas changer.

Je marque ceci comme bloqué jusqu'à ce que j'entende parler du script Google.

Première hypothèse sur ce à quoi ressemble le « meilleur » :

  • NE PAS avoir à corriger le style de la liste (pandoc via ODT peut aider)
  • copier/coller le frontmater au lieu d'éditer les sauts de ligne
  • de meilleurs raccourcis clavier pour accélérer les choses - documenté

Choses que nous ne résoudrons probablement pas :

  • images
  • caractères spéciaux? (cocher l'option odt)
  • des extraits de code (demandez aux gens de les mettre dans GitHub gists afin que nous puissions copier/coller directement)

Mise à jour sur l'endroit où cela se trouve :

Il y a quelques semaines, j'avais soumis une demande à GSA IT pour obtenir l'approbation d' un script Google .

Je pensais que le faire approuver signifierait qu'il était disponible en tant que module complémentaire, mais il s'avère que cette approbation signifie simplement que nous n'aurons pas d'ennuis, pas que son utilisation est fonctionnellement différente.

Pour m'assurer que cela fonctionnerait comme un module complémentaire, je l'ai donc testé sur mon propre compte gmail personnel et l'ai publié pour référence.

>> Script de module complémentaire fonctionnel <<

Étapes qui ont fonctionné pour moi (assurez-vous de configurer le SDK) :

  1. modules complémentaires#before_you_publish
  2. modules complémentaires

Il est important de noter que ce n'était pas du genre plug 'n play. Il y avait un tas de configuration de compte qui devra probablement être prise en charge par #infrastructure :(. Heureusement, @gboone est le responsable de l'infra pour Outreach, nous pourrions donc peut-être obtenir l'approbation.

J'ai mentionné le module complémentaire au gars à qui je parlais de GSA IT, et il n'était pas au courant de l'approbation. Dans cet esprit, les prochaines étapes sont :

  • [ ] Mentionnez que j'ai un script de travail qui créera un module complémentaire similaire à Exporter en tant que Markdown

    • [ ] Voir si quelqu'un a créé un module complémentaire

    • [ ] Sinon, voyez si quelqu'un sait en quoi le processus d'approbation serait différent pour un module complémentaire par rapport à un script autonome

  • [ ] Essayez d'obtenir de l'aide tout au long du processus de configuration
  • [ ] PLAN B : s'en tenir à l'utilisation de pandoc, mais mettre à jour la documentation sur la façon de rationaliser le processus

Nous sommes actuellement en train de pivoter pour résoudre ce problème de différentes manières :

  • [ ] @gboone va documenter les meilleures pratiques actuellement utilisées pour convertir gdocs --> odt --> markdown. GIFs ftw!
  • [ ] Je vais chercher à faire un bookmarklet pour faire la même chose
  • [ ] Greg et moi continuerons à travailler avec GSA IT pour déterminer comment nous pouvons obtenir le script que nous avons écrit ou le module complémentaire Export as Markdown existant approuvé pour une utilisation à l'échelle de l'organisation

cc @toolness @jeremyzilar

@gboone est-ce bien de fermer ?

@elainekamlley Si vous pouviez garder cela ouvert pour le moment,... J'ai envoyé ce fil à l'équipe Google Docs

Essayez gd2md-html , un module complémentaire gratuit de Google Docs que j'ai développé en tant que module complémentaire après avoir utilisé le script autonome de Renato Mangini.

Excellente nouvelle @evbacher 🎉 Nous allons le tester, puis le faire passer par notre processus d'approbation ici à la GSA. Tellement excité à propos de ça

Vous n'avez pas les ressources pour le faire. Ce serait bien d'avoir si nous obtenons les ressources. Déplacer ça sur le parking. Peut avoir besoin de ressources d'ingénierie

Je viens de soumettre gd2md à GSA IT pour approbation https://github.com/evbacher/gd2md-html/wiki

Pas assez de ressources pour travailler en ce moment.

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

Questions connexes

gboone picture gboone  ·  16Commentaires

coreycaitlin picture coreycaitlin  ·  5Commentaires

konklone picture konklone  ·  4Commentaires

iamjolly picture iamjolly  ·  6Commentaires

chuckhoupt picture chuckhoupt  ·  13Commentaires