HomeCloud ComputingFirst Code... Then Infrastructure as Code... Now Notes as Code!

First Code… Then Infrastructure as Code… Now Notes as Code!

First, let me say how we take notes and what instruments we use are admittedly a private choice and choice. Hopefully, we are doing it, nonetheless!

Most of us are creatures of behavior and luxury – we wish it easy and efficient. After we put that developer hat on as a part of our DevOps/SRE or AppDev roles it’s optimum after we can mix our code improvement setting, or IDE, with a software that we take notes in. I’m certain most of us are utilizing Microsoft’s Visible Studio Code app as we write Python or Go-based scripts and functions throughout our community programming and automation work. I in all probability knocked out 4,500 strains of Python in help of the CiscoLive Community Operations Middle (NOC) automation earlier this summer time and VS Code was integral to that.

Jason Notes as CodeMicrosoft Visible Studio Code with a CiscoLive NOC Python Script

You’re in all probability conversant in VS Code’s sturdy integration with git out of your native improvement setting and the power to synchronize with distant GitHub repositories. It’s a fantastic function to make sure model management, present code backup storage, and encourage collaboration with different builders.

Jason Notes as CodeGitHub with a CiscoLive NOC Software program Repository

I used to be inspired to search out an extension to VS Code that follows the idea of ‘Docs as Code’. For those who’re not acquainted, I’d encourage you to comply with my esteemed Developer Relations colleague, Anne Mild, who’s main a lot innovation on this house. Anne describes this idea in her GitHub repo.

The extension I take advantage of known as Dendron. It’s extra formally referred to as an open-source doc administration system. It permits for hierarchical documentation and note-taking. It makes use of the identical, acquainted markdown idea for textual content formatting, doc linking and picture references, as you’ll use with GitHubWebex messaging app or Webex API. You possibly can journal and have your ideas organized in day by day buckets. Doc templates are supported. I discover the provided assembly notes template as fairly helpful and extensible. As a proof of Dendron’s flexibility, I wrote this weblog in Dendron earlier than passing over to the publication staff!

Jason Notes as CodeVS Code with Dendron Extension: Observe Taking Panel with Preview

I respect the hierarchical mannequin of taking notes. I’ve sections for my staff notes, my tasks, the companions and prospects I’m working with, and one-on-one assembly notes. The hierarchy works down from there. As an illustration, this notice is saved within the VS Code workspace for Dendron, and its vault, as ‘MyProjects.blogs.Notes as Code.md’.  I even have a ‘MyProjects.PiK8s.md’ for a Kubernetes setting on a cluster of Raspberry Pis – extra on that quickly!

Dendron is able to effectively and shortly looking out and managing tens of hundreds of notes. Once I end a mission, I can refactor it into a special hierarchy for archive. The hyperlinks throughout the unique notice are re-referenced, so I don’t lose continuity!

I’m not prepared to do that refactor simply but, however right here’s a screensnap of it confirming the motion of the notice throughout hierarchies. I are inclined to put accomplished tasks in a ‘zARCHIVE’ department.

Jason Notes as CodeDendron Extension Utilizing Doc Refactor Characteristic

Dendron additionally helps superior diagramming with the mermaid visualization syntax. This subsequent picture is a linked screen-capture of the Dendron writing panel adjoining to the preview panel the place I imagined a workflow to get this weblog posted.

Jason Notes as CodeDendron Markdown with Preview Displaying mermaid Movement Chart

Community protocol and software program inter-process communication will be documented as sequence diagrams additionally! Right here’s my tongue-in-cheek illustration of a DHCP course of.

participant Consumer
participant Router
participant DHCP Server
Consumer->>Router: I want my IP Deal with (as broadcast)
Router->>DHCP Server: (forwarded) Get subsequent lease
DHCP Server-->>Router: This is
Router-->>Consumer: You good with
Consumer->>Router: Sure, thanks
Router->>DHCP Server: We're all set!

The markdown and preview behind the scenes seemed like this…

Dendron Markdown with Preview Displaying mermaid Sequence Diagram

So, How Can I Use This?

An efficient means of utilizing VS Code with Dendron could be in live performance with the notetaking and documentation you do on your git repos. Since Dendron notes are successfully textual content, you possibly can sync them together with your git repo and distant GitHub publication as your README.md recordsdata, LICENSE.md and CONTRIBUTING.md, which ought to make up the muse of your documented mission on GitHub.

I hope you discover the effectivity of utilizing Dendron in VS Code together with the writing of Python script in the identical as helpful as I do!

Associated assets

For those who’re all for some extra Cisco DevNet assets round mission documentation, contemplate this Code Change Repo Template on your mission – it doesn’t even should be submitted to Cisco. The principle factor is to prepare and template affordable data for others to devour and be constant.

You may as well take a look at Cisco Code Change. There you’ll discover and collaborate on curated GitHub tasks to jumpstart your work with Cisco platforms, APIs, and SDKs.

We’d love to listen to what you suppose. Ask a query or go away a remark under.
And keep linked with Cisco DevNet on social!

LinkedIn | Twitter @CiscoDevNet | Fb | YouTube Channel




Please enter your comment!
Please enter your name here

Most Popular

Recent Comments