Skip to content

Drop expired & unused schema diagrams.#416

Open
c4lliope wants to merge 1 commit into
chaoss:mainfrom
c4lliope:doc-schemas
Open

Drop expired & unused schema diagrams.#416
c4lliope wants to merge 1 commit into
chaoss:mainfrom
c4lliope:doc-schemas

Conversation

@c4lliope

Copy link
Copy Markdown

Big surprise from the "lines-of-code" report:

 loc
╭────┬──────────────────┬────────┬───────┬─────────┬────────╮
  # │       lang       │ nFiles │ blank │ comment │  code  │
├────┼──────────────────┼────────┼───────┼─────────┼────────┤
  0  SVG                    6      9        1  119452 
  1  Python               303  11678    14206   30055 
  2  SQL                   25   9393     8699   19873 
  3  YAML                   8     75       95    6457 
  4  JSON                   6      0        0    2588 
  5  Jinja Template        22    163      175    2301 
  6  reStructuredText      55   1215      788    1619 
  7  Markdown              23    309        9     756 
  8  CSS                    3    103       23     635 
  9  TOML                   1     14       21     143 
 10  Text                   2      2        0     137 
 11  Dockerfile             4     49       23     123 
 12  HTML                   1     10        0      86 
 13  INI                    1     22        0      80 
 14  Bourne Shell           2     14        7      73 
 15  make                   2     19       18      51 
 16  CSV                    4      0        0      22 
 17  Mako                   1      7        0      17 
 18  JavaScript             3      2        2      15 
╰────┴──────────────────┴────────┴───────┴─────────┴────────╯

SVG!?

Three of these SVG files are schema graphics:

 nodes | where { ($in |path parse).extension == svg }
╭───┬──────────────────────────────────────────────────────────────────╮
 0  ./collectoss/application/schema/20210811-augur-0.2.1-release.svg 
 1  ./collectoss/static/favicon/favicon_source.svg                   
 2  ./collectoss/static/img/collectoss-logo-black.svg                
 3  ./collectoss/static/img/collectoss-logo-white.svg                
 4  ./collectoss/static/img/notification-icon.svg                    
 5  ./docs/source/schema/20211006-augur-0.21.0-release.svg           
 6  ./docs/source/schema/schema.svg                                  
╰───┴──────────────────────────────────────────────────────────────────╯

Entries # 5 and 6 are duplicates:

❄ calliope@chesapeake:  …/collectoss   main     12:46 
 diff docs/source/schema/20211006-augur-0.21.0-release.svg docs/source/schema/schema.svg

❄ calliope@chesapeake:  …/collectoss   main     12:46 

These svgs are unused; and here are the necessary schema pngs:

❄ calliope@chesapeake:  …/collectoss   main     12:46 
 rg svg docs
docs/source/schema/20211006-augur-0.21.0-release.svg
2:<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="9440pt" height="8465pt" viewBox="0 0 9440 8465" version="1.1">
59022:</svg>

docs/source/schema/schema.svg
2:<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="9440pt" height="8465pt" viewBox="0 0 9440 8465" version="1.1">
59022:</svg>

❄ calliope@chesapeake:  …/collectoss   main     12:46 
 rg img docs
 rg 'schema.*png' docs
docs/source/schema/dependencies.rst
4:.. image:: images/20211011-dependencies-augur-schema-v0.21.1.png

docs/source/schema/overview.rst
12:.. image:: schema.png
21:.. image:: images/20211011-augur-schema-v0.21.1.png

docs/source/schema/pull-requests.rst
4:.. image:: images/20211011-pull-requests-augur-schema-v0.21.1.png

docs/source/schema/issues.rst
4:.. image:: images/20211011-issues-augur-schema-v0.21.1.png

docs/source/schema/contributors.rst
4:.. image:: images/20211011-contributors-augur-schema-v0.21.1.png

docs/source/schema/commits.rst
4:.. image:: images/20211011-commits-augur-schema-v0.21.1.png

Here are the remaining schema images:

 nodes | where { ($in |path parse).extension == png } | where { ($in | path basename) =~ schema } | where { $in !~ build }
╭───┬─────────────────────────────────────────────────────────────────────────────╮
 0  ./docs/source/schema/images/20211011-augur-schema-v0.21.1.png               
 1  ./docs/source/schema/images/20211011-commits-augur-schema-v0.21.1.png       
 2  ./docs/source/schema/images/20211011-contributors-augur-schema-v0.21.1.png  
 3  ./docs/source/schema/images/20211011-dependencies-augur-schema-v0.21.1.png  
 4  ./docs/source/schema/images/20211011-issues-augur-schema-v0.21.1.png        
 5  ./docs/source/schema/images/20211011-pull-requests-augur-schema-v0.21.1.png 
 6  ./docs/source/schema/schema.png                                             
╰───┴─────────────────────────────────────────────────────────────────────────────╯

I'm in no hurry to merge this - I'd like to clean up the generated images as much as possible, and that means:

  • dig up the commands used to produce these graphics
  • produce these graphics dynamically during make docs
  • remove remaining copies, including .jpg and .pdf
  • discuss why one of these was residing inside collectoss/application

@c4lliope c4lliope requested a review from MoralCode as a code owner June 25, 2026 18:04
@MoralCode

MoralCode commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

dig up the commands used to produce these graphics
produce these graphics dynamically during make docs

OMG if you could figure this out that would be fantastic. This has been a long term project (#207) that hasnt every really been given the priority it should. As far as i can tell, these were generated based on old .ndm2 data files that were representing the schema prior to the migration to alembic (some of them stick around to this day but their ultimate destiny is to be deleted as part of #165)

Ive given "create a new script to generate these graphics" a shot already as well. Those changes were just pushed to the feat/gen-schema branch if that helps.

[Edit: remaining information that was here has been moved to the underlying issue for this project #207]

@c4lliope

Copy link
Copy Markdown
Author

Yay! I'll begin following your lead. If I do begin from square one, I'll probably choose https://d2lang.com/

@MoralCode MoralCode left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this looks good to me. As long as the docs build CI still passes, im happy to merge this and remove the rest of the images once we have #207 resolved.

Dont forget to signoff your commits (see contributing.md for a section explaining how to do that)

@MoralCode

Copy link
Copy Markdown
Contributor

looks like the docs build is failing with /home/runner/work/CollectOSS/CollectOSS/docs/source/schema/regularly_used_data.rst:230: WARNING: image file not readable: schema/images/releases.png

so somewhere in the docs that releases.png image is being referenced still

@MoralCode MoralCode added the documentation Improvements or additions to documentation label Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants