First, let me say how we take notes and what instruments we use are admittedly a private choice and determination. Hopefully, we are doing it, nevertheless!
Most of us are creatures of behavior and luxury – we wish it easy and efficient. Once we put that developer hat on as a part of our DevOps/SRE or AppDev roles it’s optimum once we can mix our code improvement surroundings, or IDE, with a device that we take notes in. I’m positive 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 most likely knocked out 4,500 traces of Python in help of the CiscoLive Community Operations Middle (NOC) automation earlier this summer time and VS Code was integral to that.
Microsoft Visible Studio Code with a CiscoLive NOC Python Script
You’re most likely accustomed to VS Code’s robust integration with git out of your native improvement surroundings and the power to synchronize with distant GitHub repositories. It’s a terrific characteristic to make sure model management, present code backup storage, and encourage collaboration with different builders.
GitHub 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’. When you’re not acquainted, I’d encourage you to observe my esteemed Developer Relations colleague, Anne Mild, who’s main a lot innovation on this area. Anne describes this idea in her GitHub repo.
The extension I exploit is 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 GitHub, Webex messaging app or Webex API. You may journal and have your ideas organized in every 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 group!
VS Code with Dendron Extension: Notice Taking Panel with Preview
I admire the hierarchical mannequin of taking notes. I’ve sections for my group notes, my tasks, the companions and clients I’m working with, and one-on-one assembly notes. The hierarchy works down from there. For example, this observe 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 surroundings on a cluster of Raspberry Pis – extra on that quickly!
Dendron is able to effectively and rapidly looking out and managing tens of hundreds of notes. After I end a venture, I can refactor it into a special hierarchy for archive. The hyperlinks throughout the unique observe 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 observe throughout hierarchies. I are likely to put accomplished tasks in a ‘zARCHIVE’ department.
Dendron 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.
Dendron Markdown with Preview Exhibiting mermaid Stream Chart
Community protocol and software program inter-process communication could be documented as sequence diagrams additionally! Right here’s my tongue-in-cheek illustration of a DHCP course of.
```mermaid sequenceDiagram participant Consumer participant Router participant DHCP Server Consumer->>Router: I would like my IP Tackle (as broadcast) Router->>DHCP Server: (forwarded) Get subsequent lease DHCP Server-->>Router: Here is 192.168.1.100 Router-->>Consumer: You good with 192.168.1.100? Consumer->>Router: Sure, thanks Router->>DHCP Server: We're all set! ```
The markdown and preview behind the scenes appeared like this…
Dendron Markdown with Preview Exhibiting mermaid Sequence Diagram
So, How Can I Use This?
An efficient manner of utilizing VS Code with Dendron can be in live performance with the notetaking and documentation you do in your git repos. Since Dendron notes are successfully textual content, you’ll be able to sync them together with your git repo and distant GitHub publication as your README.md information, LICENSE.md and CONTRIBUTING.md, which ought to make up the inspiration of your documented venture 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 useful as I do!
Associated assets
When you’re considering some extra Cisco DevNet assets round venture documentation, take into account this Code Trade Repo Template in your venture – it doesn’t even need to be submitted to Cisco. The principle factor is to arrange and template cheap info for others to devour and be constant.
You can too take a look at Cisco Code Trade. 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 assume. Ask a query or depart a remark beneath.
And keep linked with Cisco DevNet on social!
LinkedIn | Twitter @CiscoDevNet | Fb | YouTube Channel
Share: