Add How-to & references pages, plus supporting metadata

jmacdotorg commented 3 weeks ago

Update various Hugo-related files in preparation for a subsequent documentation content update.

Add .hugo_build.lock to .gitignore.
Update hugo.yaml to allow HTML elements within Markdown source files.
Add a custom shortcode for wrapping placeholders in code snippets in <var> tags.
Add two shortcodes to store the URL paths to the new and legacy proxy documentation.
Add custom CSS for putting a non-copyable $ prompt before console-command illustrations.

Add and update the content in proxy2 with new how-to and reference documentation for installing, configuring, and running the proxy using the standard route library.

dormando commented 2 weeks ago

I like the vibe of where this is going.

Not sure if you intended for me to fix the smaller things myself, but I noted a bunch of them. Some things are larger issues, ie; missing sections. Or need to make a decision on how to document something best (ie; the settings section, which doesn't use mcp. function calls)

dormando commented 2 weeks ago

This makes it stand out to me a lot that I need to get routelib bundled in the source code asap... sigh..

jmacdotorg commented 2 weeks ago

I like the vibe of where this is going.

Not sure if you intended for me to fix the smaller things myself, but I noted a bunch of them. Some things are larger issues, ie; missing sections. Or need to make a decision on how to document something best (ie; the settings section, which doesn't use mcp. function calls)

Let's treat this as a proper code review; point out what's wrong, and I'll revise as needed to get your ultimate approval.

There aren't any intentionally missing sections here, so let's chat about what I've overlooked, and I'll make those revisions too.

dormando commented 2 weeks ago

lmk if I should review again. I see the last code review as still open in GH

jmacdotorg commented 2 weeks ago

This makes it stand out to me a lot that I need to get routelib bundled in the source code asap... sigh..

Sure thing, will follow up when it's ready for another review.

jmacdotorg commented 2 weeks ago

in routes{} section, cmap can be a top level thing, ie:

https://github.com/memcached/memcached-proxylibs/blob/main/lib/routelib/examples/commandmap.lua

You can even mix map, cmap, and default: memcached/memcached-proxylibs#7 (comment)

IE:

check map for key prefixes for special handling

if none match, check the cmap for a 'get' override (ie: failover, try pool A first)

else hit the default, which is allsync for all replicated pools (ie; set commands)

I have rewritten the routes{} section to add cmap and examine that and the other possible sub-sections in greater detail. (https://github.com/memcached/memcached.github.io/pull/3/commits/43bf006c1084a0c6439f6566bbe5de364d0c2dfe)