Skip to content

First draft of At A Glance article - #53

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

First draft of At A Glance article#53
eenblam wants to merge 3 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

Suppose that we have nodes in Amsterdam and London, and we want to establish a core link between them.

On the Subscriptions page, we can see that we already have a subscription for each node, so we create a link via the New Subscription dropdown.
![Create Core Link dropdown](../img/at-a-glance/create_core_link_dropdown.png)

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.

Maybe we can look into a way to allow users to click on an image so it pops out into a larger version, in some kind of modal. Currently I can only read what's on the image by right clicking and opening it in a new tab, otherwise it's just a bit too small. (I'll have a look into plugins)

Image

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.

#56 what do you think?

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.

Having an issue running that branch, commented on it in that MR

@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
Suppose that we have nodes in Amsterdam and London, and we want to establish a core link between them.

On the Subscriptions page, we can see that we already have a subscription for each node, so we create a link via the New Subscription dropdown.
![Create Core Link dropdown](../img/at-a-glance/create_core_link_dropdown.png)

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.

#56 what do you think?

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.

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