Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖♻️:diffuse agent forwarding content for openinf core in 2024 #1106

Merged
merged 48 commits into from
Mar 13, 2024

Conversation

DerekNonGeneric
Copy link
Member

@DerekNonGeneric DerekNonGeneric commented Jan 29, 2024

Friends tell friends they love GnuPG

Posted 13th November 2013 by Sam Tuke

🔗:https://t.co/WH7lpD30IK pic.twitter.com/hxHsV9Etw7

— OpenINF (@OpenINF) January 29, 2024



image



There is a secret sweetspot achieving delightful experience
otherwise not really something casual contributors should
be expected to be doing simply for making a contribution.



We should now be (and look to have already started on) taking the topic
in a few different directions (perhaps also improving discoverability):

Copy link

netlify bot commented Jan 29, 2024

👷 Deploy Preview for open-inf-is processing.

Name Link
🔨 Latest commit 071b705
🔍 Latest deploy log https://app.netlify.com/sites/open-inf-is/deploys/65f1439d59b04100081afb4b

@DerekNonGeneric DerekNonGeneric changed the title doc: Agent Forwarding of OpenINF Core in 2024 doc: agent forwarding for openinf core in 2024 Jan 29, 2024
Copy link
Member Author

@DerekNonGeneric DerekNonGeneric left a comment

Choose a reason for hiding this comment

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

please excuse the roughness of this document as we develop it further;
this was not originally intended for any audience of readers other than myself
as they still seem to be closer to notes (?)

i am going to breakfast now, but fortunately starting to feel the passion
for this topic again, which motivates much more than anything

GPG keys to work correctly. So you have to ensure they are available on the
remote system even if your secret keys are not.

\[\[note\]\]
Copy link
Member Author

@DerekNonGeneric DerekNonGeneric Jan 29, 2024

Choose a reason for hiding this comment

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

Suggested change
\[\[note\]\]
\[\[note\]\]

btw, this cute lil admonition syntax was previously ruled as being non-preferable

[…] should've been a directive.

Square brackets are used a lot already in markdown […]
https://twitter.com/wooorm/status/1701865524236345734

Copy link
Member Author

Choose a reason for hiding this comment

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

this would be a nice time for windings font selection

we'd have some diverse surrounding content and not all the text is uniform

🔗 https://dereknongeneric.github.io/agent-forwarding-eye-candy/agent-forwarding.html

Copy link
Member Author

Choose a reason for hiding this comment

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

y'know, at first i was having trouble deciding
whether to keep the leading section numbers or
move that to some other place that doesn't interfere,
but now i really like how their addition makes it look academic

Copy link
Member Author

Choose a reason for hiding this comment

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

btw, the HTML to Markdown conversion was done via online tool:

🔗 https://htmltomd.com/

briefly glancing at the output; it had stripped wayyy more tags than Pandoc
so, i was like "screw it, nobody else even comes close", but not sure why
all the backslashes have been applied to basically anything that can be

Copy link
Member Author

@DerekNonGeneric DerekNonGeneric Jan 30, 2024

Choose a reason for hiding this comment

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

re-reading OpenINF/GitHub-Markdown#4 now and
gearing up for its demolition, which we are running
late, but kaboom happens in ~2hr 15min (10pm EST)

who like me still feels weird about using the aside HTML tag for them?

maybe i will feel better about it after reading those things on them

Copy link
Member Author

@DerekNonGeneric DerekNonGeneric Jan 30, 2024

Choose a reason for hiding this comment

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

last note worth mentioning on styleguide conventions
similar to those seen elsewhere: we used to
have our own freaking baby styleguide in our top-level
org dotrepo:

🔗 OpenINF/.github@f720bce

in retrospect, i do not change my opinion about that being the wrong place for that handbook sub-project, which i was imagining would outgrow (in amount of content) the repo it had started in and the dot-prefix-namesake would soon have made no sense at all

regretting my decision of not migrating it else where tho

Copy link
Member

@OpenINFbot OpenINFbot Jan 30, 2024

Choose a reason for hiding this comment

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

RE - ⬇️:

re-reading OpenINF/GitHub-Markdown#4 now and
gearing up for its demolition, which we are running
late, but kaboom happens in ~2hr 15min (10pm EST)
who like me still feels weird about using the aside HTML tag for them?

maybe i will feel better about it after reading those things on them
Originally posted by @DerekNonGeneric in #1106 (comment)

GF - 🏛️:

opted for making old GF contiue her life in archive formhttps://t.co/J61RYALoyX— OpenINF (@OpenINF) January 30, 2024

Originally posted by @DerekNonGeneric in #1106 (comment)

Copy link
Member Author

@DerekNonGeneric DerekNonGeneric Feb 1, 2024

Choose a reason for hiding this comment

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

Suggested change
\[\[note\]\]
:::note{.note}

the actual resulting suggestion is better than this (gimme a sec to dig it up)

Copy link
Member Author

@DerekNonGeneric DerekNonGeneric Feb 1, 2024

Choose a reason for hiding this comment

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

the actual resulting suggestion is better than this (gimme a sec to dig it up)

🔗 https:/micromark/micromark-extension-directive?tab=readme-ov-file#syntax

micromark-extension-directive has definitely thought this out more clearly


ok, a few more to consider; would like to have this "override" title

the translations can happen in the document if necessary

@DerekNonGeneric DerekNonGeneric changed the title doc: agent forwarding for openinf core in 2024 📖♻️:diffuse agent forwarding content for openinf core in 2024 Jan 29, 2024
@DerekNonGeneric DerekNonGeneric added 📦 Type: Developer Dependencies PRs that modify packages only req'd for local development and testing 🛠️ Category: Tools Issues and PRs related to the tools directory 🛄 Status: Claimed Issues that have been claimed to be undertaken by someone labels Jan 29, 2024
@DerekNonGeneric DerekNonGeneric added 📖 Category: Documentation Improvements or additions to documentation 📝 Category: Content Related to creating / editing content usually require some knowledge of Markdown labels Jan 31, 2024
DerekNonGeneric and others added 12 commits March 3, 2024 00:00
PR URL: #1139
Reviewed-by: OpenINF Bot <[email protected]>
Signed-off-by: Derek Lewis <[email protected]>
Co-authored-by: Restyled.io <[email protected]>
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
PR URL: #1140
Reviewed-by: Derek Lewis <[email protected]>
Reviewed-by: OpenINF Bot <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
PR URL: #1141
Reviewed-by: OpenINF Bot <[email protected]>
Signed-off-by: Derek Lewis <[email protected]>
Co-authored-by: Restyled.io <[email protected]>
Acked-by: Princess Irulen <[email protected]>
PR URL: #1143
Reviewed-by: OpenINF Bot <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
This is an attempt to get #1142 passing CI.

Refs: #1142

Signed-off-by: Derek Lewis <[email protected]>
PR URL: #1142
Reviewed-by: Derek Lewis <[email protected]>
Reviewed-by: OpenINF Bot <[email protected]>
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
PR URL: #1145
Reviewed-by: Derek Lewis <[email protected]>
Reviewed-by: OpenINF Bot <[email protected]>
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Refs: https://x.com/OpenINF/status/1762686158784401517
PR URL: #1154
Reviewed-by: OpenINF Bot <[email protected]>
Signed-off-by: Derek Lewis <[email protected]>
Cc: Jorge Bucaran <[email protected]>
Co-Authored-By: Princess Irulen <[email protected]>
@OpenINFbot
Copy link
Member

OpenINFbot and others added 3 commits March 4, 2024 17:37
@OpenINFbot
Copy link
Member

this pr has unrelated changes in the diff; one moment

@DerekNonGeneric DerekNonGeneric marked this pull request as ready for review March 13, 2024 05:48
@DerekNonGeneric
Copy link
Member Author

we are going to merge this tonight, even incomplete!

@DerekNonGeneric DerekNonGeneric added 🚅 Status: Fast Track PRs that do not need to wait for 48 hours to land 🗒️ todo PRs that add code with TODO comments labels Mar 13, 2024
@DerekNonGeneric
Copy link
Member Author

DerekNonGeneric commented Mar 13, 2024

Codacy calls out a bunch of things still wrong with the document

true, there are many things still wrong with the document

we have not standardized many of the practices yet;

so merging

Copy link
Member

@OpenINFbot OpenINFbot left a comment

Choose a reason for hiding this comment

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

i expect a revamp as follow-up

@OpenINFbot OpenINFbot merged commit 80422bc into live Mar 13, 2024
17 of 18 checks passed
@OpenINFbot OpenINFbot deleted the sukeban/agent-forwarding branch March 13, 2024 06:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Category: Content Related to creating / editing content usually require some knowledge of Markdown 📖 Category: Documentation Improvements or additions to documentation 🛠️ Category: Tools Issues and PRs related to the tools directory 🛄 Status: Claimed Issues that have been claimed to be undertaken by someone 🚅 Status: Fast Track PRs that do not need to wait for 48 hours to land 🚧 Status: Work In Progress (WIP) undefined 🗒️ todo PRs that add code with TODO comments 📦 Type: Developer Dependencies PRs that modify packages only req'd for local development and testing ✨ Type: Feature undefined
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants