Rework our release process documentation.#91
Open
crypticC0der wants to merge 1 commit into
Open
Conversation
fnordahl
requested changes
May 15, 2026
fnordahl
left a comment
fnordahl
left a comment
Member
There was a problem hiding this comment.
Executable documentation is a great concept and will help us avoid documentation and code getting out of sync!
The change overall looks good to me, but I have an ask for the commit and PR message:
The use of the phrase "less enlightened" comes across as a negative to me.
Would you consider using the word "uninitiated" instead?
crypticC0der
force-pushed
the
main
branch
2 times, most recently
from
bfb0ab6 to
9f21d93
Compare
crypticC0der
force-pushed
the
main
branch
2 times, most recently
from
d7c92d7 to
b44d451
Compare
This introduces example code blocks for our release documentation, which are easily runable with "RET" within org mode, or "SPC m e O O" to export the whole file to a buffer containing the output of each block alongside the code. For our uninitiated users, we now have the org-accessability directory, which I aim to expand with scripts giving core org-mode QoL features to those who dont use emacs. Currently this just contains the "org-runner.py" script, which extracts source blocks and then runs them with the relevant interpreter. This should allow streamlined microovn-operator releases, alongside the ability for a non-emacs user to follow along with documentation such as README.org Signed-off-by: MJ Ponsonby <mj.ponsonby@canonical.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This introduces example code blocks for our release documentation, which are easily runable with "RET" within org mode, or "m e O O" to export the whole file to a buffer containing the output of each block alongside the code.
For our less enlightened users, we now have the org-accessability directory, which I aim to expand with scripts giving core org-mode QoL features to those who dont use emacs. Currently this just contains the "org-runner.py" script, which extracts source blocks and then runs them with the relevant interpreter.
This should allow streamlined microovn-operator releases, alongside the ability for a non-emacs user to follow along with documentation such as README.org