team-compass icon indicating copy to clipboard operation
team-compass copied to clipboard

Consolidate meeting notes in yearly files instead of monthly

Open choldgraf opened this issue 2 years ago • 3 comments

Right now, we store our team meeting notes in a number of monthly and or weekly files. However, having lots of files makes Sphinx builds slow down quite a lot, and most people won't have trouble navigating by year -> month subsection.

Proposal

I'd like to do three things:

  • Consolidate monthly team meeting notes into yearly team meeting notes
  • Consolidate weekly / earlier team notes into a single page
  • Set up redirects for all moved files to the consolidated pages

choldgraf avatar Nov 25 '22 15:11 choldgraf

https://github.com/jupyterhub/team-compass/tree/main/docs/meetings/community

  • 51 reports https://github.com/jupyterhub/team-compass/tree/main/docs/meetings/hpc
  • 22 reports https://github.com/jupyterhub/team-compass/tree/main/docs/meetings/weekly-reports
  • 1 report

74 reports doesn't seem that many, do you know what's causing the slowdown in the build?

manics avatar Nov 26 '22 15:11 manics

It's not a huge slowdown, just enough to be noticeable, which is annoying if you're demoing lots of little doc changes. But I don't think this issue is crucial or anything, so perhaps we can leave it here as a data point and if others become annoyed by this in the future, they can chime in in our comments?

choldgraf avatar Nov 28 '22 12:11 choldgraf

It's not a huge slowdown, just enough to be noticeable, which is annoying if you're demoing lots of little doc changes.

When i make smaller changes, I use make devenv, but the key part is that won't don't delete the build folder. If the build folder isn't deleted, only whats relevant to rebuild is being rebuilt, making the large amount of files be a one off build issue.

Sometimes I delete the build folder to ensure I start fresh still though, I think anything related to the index files is prone to need a new build.

I don't think this issue is crucial or anything, so perhaps we can leave it here as a data point and if others become annoyed by this in the future, they can chime in in our comments?

:+1:

consideRatio avatar Nov 29 '22 10:11 consideRatio