Document operational and technical information

[darkdrgn2k]

^{This initial comment is collaborative and open to modification by all.}

Task Summary

🎟️ Re-ticketed from: #
📅 Due date: N/A
🎯 Success criteria: Have relevant documentation added to https://docs.tomesh.net from the list below.

Keep operational and technical documentation in a well-structured book for anyone to easily find current information. Currently they are spread across multiple spaces and hard to discover/navigate.

To Do

These need to be fit into the docs chapters in the next section.

Migrat Content

• [ ] #15 Select Router
  • [x] #22 Router X As Router
  • [ ] #12 - Espresso bin As Router
• [x] #5 Super Node 1 Hardware
• [x] #6 ExitNode
• [x] #29 200 Woolner deployment
• [ ] #21 Naming/Numbering Standards
• [ ] #30 Toronto Mesh naming
• [x] #90 Routing Hardware - OmniTik
• [ ] #35 Onboarding
• [ ] #72 Work from heights training
• [ ] #50 Default Routes Co-Existing

To be blogged

• [ ] #34 Supernode 1 field testing

No Content

• [ ] #17 - Nema Cabinate
• [ ] #20 POE Switch

Docs chapters

Please edit this comment to add sections. Use of subchapters is encouraged.

• [ ] Introduction - explains the Toronto Community Network, and what the docs/book is for
• [ ] Glossary
• [ ] How we work
  • [ ] Digital spaces and working group meetings
• [ ] #35 Contributor onboarding
• [ ] How to join the mesh
  • Guide-style writeup
  • Not about joining TCN / Toronto Mesh
  • Hardware required, software setup instructions, links to get in touch
• [ ] Branding guideline
  • [ ] #30 Toronto Mesh naming
  • [ ] Logo, colour schemes, etc
• [ ] Standards
  • [ ] #21 Naming/Numbering Standards, IP address allocation
  • [ ] #57 Node schema and link to assets
• [ ] Hardware
  • [ ] Benchmark
  • Add subchapters for hardware in use, recommendations, pros and cons, etc
• [ ] Network
  • [x] Supernode 1 #29 200 Woolner
    • [x] #34 Supernode 1 field testing
  • [ ] Neighborhood Nodes
  • [x] Exit nodes - idk what to put here exactly - #6
  • [x] Babel
• [x] Managing Secrets - needs a section to be under maybe
• [ ] Policies
  • [ ] Fair use policy
  • [ ] Data policy
  • [ ] Docs license
  • [ ] Code of Conduct

---

Docs are being worked on in the toronto-community-network-docs repo.

[makew0rld]

54 might supersede this issue.

[darkdrgn2k]

Discuss scope of issues

[makew0rld]

Done today, this issue will stay open. I've updated it to include any new issues I found previously.

[makew0rld]

Overall network topology images: benhylau drawing and DD2k diagram

[benhylau]

I think a quick way to get stuff transferred is to agree on the "chapters" index and then transfer content on there, then assign one person to go thru all of it, make everything consistent and pretty.

[makew0rld]

Yeah, starting to create a draft/template of all the sections sounds like the right idea. Can this be done in this issue, or should there be another?

[benhylau]

I think it can be in this, and check off sections as they get merged.

[makew0rld]

Should the docs have sections explaining what the network is in depth, with an FAQ, etc? Or should that be on tomesh.net?

[darkdrgn2k]

I would suggest putting the above comment as part of the first one.

that way we don't have to dig for it!

[makew0rld]

Done, thanks. I've left my question though.

[darkdrgn2k]

34 Supernode 1 field testing

This seems like more of a tomesh/documents write up about what we did (the event) and just the results in the docs.

[makew0rld]

I think it definitely depends on the nature of the write up. It'd be nice to have some info in the docs on how it was done, like with tips or important info. But any sort of narrative would be better for a blog post or document.

[darkdrgn2k]

Discussed in one of the meetings (ops or govnt dont remember)

Docs.tomesh.net will be a "manual" so facts an figures.

While the Journal/Blog/Event recap will be in some other location (blog maybe, or docs)