Open alpgarcia opened 5 years ago
Two comments:
- rename
chaoss-gmd-cde
tochaoss-gmd-wg-code-development
I renamed it the other way around because @dicortazar thought it was too long : P
for each
<collection_name>/<panel_file_name>.json
there must be adocs/_<collection_name>/<panel_file_name>.md
anddocs/assets/images/<collection_name>/<panel_file_name>.jpg
After reading this I think you are the right person to review #304. @sduenas do you know if this check could be hooked somewhere?
If anyone complains, I would suggest to create a PR with these modifications.
Two comments:
- rename
chaoss-gmd-cde
tochaoss-gmd-wg-code-development
I renamed it the other way around because @dicortazar thought it was too long : P
For me, the cde
part was a bit tricky. It could be: chaoss-gmd-wg-code-dev
for each
<collection_name>/<panel_file_name>.json
there must be adocs/_<collection_name>/<panel_file_name>.md
anddocs/assets/images/<collection_name>/<panel_file_name>.jpg
After reading this I think you are the right person to review #304. @sduenas do you know if this check could be hooked somewhere?
If anyone complains, I would suggest to create a PR with these modifications.
Ok
First of all, is it a repository of one collection of panels, or several collections? It seems it's growing to several panels collections, isn't it?:
json
(current GrimoireLab standard panels). These are the ones installed also through PyPi packages (see panels directory used in the package)dashboards-cauldron
. The legacy panels used in Cauldron.io. They should be deprecated at some pointchaoss-gmd-cde
. The upcoming CHAOSS GMD Code Development focus area panelsThere are also code and tools related with panels management, that are stored here too:
import_panels.sh
src
directorySo, my proposal would be:
.json
panels files directories. I would recommend to avoid acronyms. So they could become:json
folder tosigils
: standard set of GrimoireLab panels. It would be needed to rewrite the symbolic link inpanels
directory (or improve the way the package manages the panels collections), and maybe it could have some undesired effects in current Bitergia deployment infra (but that's Bitergia issue, not GrimoireLab Sigils issue).dashboards-cauldron
tocauldron
: set of panels used in Cauldron.iochaoss-gmd-cde
tochaoss-gmd-wg-code-development
utils
directory, with its own README.md or set of.md
files for documentationdocs
folder for GrimoireLab Sigils and its collections documentation. This mean, that there could be several docs or pages in that folder, and a set of collections with the same names that the ones used in the root directory for the directories of.json
files.