stackabletech / stackabletech/documentation

Improve docs authoring experience

Ouverte
#519 5 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
CSS
Étoiles
13
Forks
14
Merge moyen
4 j 8 h
PR mergées (30 j)
10

Description

As a dev, writing docs is made unpleasant by a few things in the process, especially when writing docs for an Operator, because multiple repos are involved.

Currently the workflow is:

  • checkout both the docs repo and the operator repo
  • edit the playbook file to point to the local operator repo checkout
  • write the docs in the operator repo and rebuild the docs periodically

Main pain points are:

  • the setup is cumbersome
  • build times are long
### Tasks
- [ ] Cache UI bundle in the build
- [ ] investigate Atlas/partial build extension

Links:

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner l’extension Antora Atlas et l’extension de builds partiels liées dans l’issue, puis examinez le workflow actuel de build de la documentation. Définissez l’impact du caching des bundles d’UI et des builds partiels sur la configuration à deux repositories ; le travail sera considéré comme terminé lorsqu’un workflow d’authoring documenté et fonctionnel, avec des temps de build plus courts, sera disponible.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Domaine
documentation, tooling
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.