Publish Form Tabs missing supporting documentation
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 48/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- php
- Domaine
- documentation
Piste de recherche
Start by reading the tab-file, add-on setup, and add-on update documentation pages named in the issue. Clarify what it means to indicate a tab in the update file, document the tabs() function and its use during installation and uninstallation, and consider adding a table of contents to the update-file page. Done when the documentation explains these steps clearly.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Description of the problem
On https://docs.expressionengine.com/latest/development/tab-files.html#anatomy-of-a-tab-file it includes a note:
Note: if your module includes a tab, do not forget to indicate this in the update file when installing the module. Further, be sure to include the tabs() function in the update file, and use it when updating custom layouts on installation and uninstallation.
This doesn't really provide any useful information until more context is added to other places in the documentation.
- It's not clear what "indicate this in the update file" means or how to do that. https://docs.expressionengine.com/latest/development/addon-setup-php-file.html doesn't seem to have any additional information about that.
- https://docs.expressionengine.com/latest/development/add-on-update-file.html doesn't have any information about the
tabs()function.
Edit: adding a Table of Contents to https://docs.expressionengine.com/latest/development/add-on-update-file.html would be helpful too.
- Langage dominant
- CSS
- Étoiles
- 22
- Forks
- 79
- Merge moyen
- 2 j 1 h
- PR mergées (30 j)
- 6
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de ExpressionEngine/ExpressionEngine-User-Guide
-
Inconsistent code block spacingOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 72/100
-
registration form docsOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 55/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 45/100
-
Clarify autosave interval valueOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 55/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 46/100
Toutes les issues de ExpressionEngine/ExpressionEngine-User-Guide
Issues similaires
-
area/docs
Difficulté 1/5 Moins d'une heure Accessibilité débutants 83/100
Clodmony/starship-coop#72 ·
Les mainteneurs répondent en général sous 1 jour
-
documentation needs-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
nearform/ag-grid-url-sync#315 · 1 réaction ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
DigitecGalaxus/next-yak#727 · 1 réaction ·
-
documentation enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
good first issue priority:low type:docs
Difficulté 1/5 1-3 heures Accessibilité débutants 95/100
crazy-goat/rabbit-stream#969 ·
Les mainteneurs répondent en général sous 1 jour