Skip to content

First draft of At A Glance article - #53

Open
eenblam wants to merge 5 commits into
mainfrom
eenblam/19-enhancement-not-a-video-crash-course
Open

First draft of At A Glance article#53
eenblam wants to merge 5 commits into
mainfrom
eenblam/19-enhancement-not-a-video-crash-course

Conversation

@eenblam

@eenblam eenblam commented Aug 7, 2026

Copy link
Copy Markdown

Here's my first pass at a draft of the "not a video" crash course.

The goal is provide a brief elevator pitch that's accessible to network operators, developers, managers, etc. People want to know what it is, what it does, and what it would look like to use it.

Some open questions for reviewers:

  • Where would this ideally live in the sidebar?
  • Do we want to call it "At A Glance"? Something else?
  • Is there additional content we want? Phrasing to change?

Closes #19

Comment thread docs/architecture/at-a-glance.md

@Mark90 Mark90 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.

Great start! Left some comments.

I'm also not sure yet where best to place this in the nav bar

Comment thread docs/architecture/at-a-glance.md Outdated
Comment thread docs/architecture/at-a-glance.md
Comment thread docs/architecture/at-a-glance.md
Comment thread docs/architecture/at-a-glance.md
Comment thread docs/architecture/at-a-glance.md Outdated
Comment on lines +67 to +72
# Behind the Scenes

So what's actually happening behind the scenes when we run these workflows?

WFO provides none of the facilities for talking to Netbox, NSO, Ansible, etc.
These features are implemented by other packages or by the software team leveraging the framework.

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.

This section could probably be expanded a little more

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I elaborated a bit, but I'm not sure if it's in the direction you have in mind. What would feel most helpful / relevant to share?

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.

On second read it is good actually. "WFO provides none of the facilities for talking to Netbox, NSO, Ansible, etc." is fair, although for ansible there is the option to use LSO.

Maybe we could also briefly describe in the next paragraph the (at least for us, and in example-orchestrator) common pattern of implementing a services/netbox.py module for system interaction, and using that in workflow steps.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Updated with a tiny little commit!

@Mark90 Mark90 mentioned this pull request Aug 15, 2026
Ben Elam and others added 4 commits August 18, 2026 13:15
* Add mkdocs-glightbox for clicking on screenshots to enlarge them

* Fix mkdocs-glightbox not working consistently

* Fix reload error on subprojects
@Mark90
Mark90 force-pushed the eenblam/19-enhancement-not-a-video-crash-course branch from 30dd427 to f31d68b Compare August 18, 2026 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Enhancement]: "Not a Video" crash course

2 participants