grimoirelab-sigils
grimoirelab-sigils copied to clipboard
Update directories and file names to be more meaningful
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 panels
There are also code and tools related with panels management, that are stored here too:
import_panels.shsrcdirectory
So, my proposal would be:
- provide meaningful names to the
.jsonpanels files directories. I would recommend to avoid acronyms. So they could become:- rename
jsonfolder tosigils: standard set of GrimoireLab panels. It would be needed to rewrite the symbolic link inpanelsdirectory (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). - rename
dashboards-cauldrontocauldron: set of panels used in Cauldron.io - rename
chaoss-gmd-cdetochaoss-gmd-wg-code-development
- rename
- move the tools and scrips to a
utilsdirectory, with its own README.md or set of.mdfiles for documentation - use
docsfolder 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.jsonfiles.
Two comments:
- rename
chaoss-gmd-cdetochaoss-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>.jsonthere must be adocs/_<collection_name>/<panel_file_name>.mdanddocs/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-cdetochaoss-gmd-wg-code-developmentI 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>.jsonthere must be adocs/_<collection_name>/<panel_file_name>.mdanddocs/assets/images/<collection_name>/<panel_file_name>.jpgAfter 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