Test with all supported OS/platform configuration.

Update CLI document with additional keywords, such as --array-map and --extra-params.

        --array-map <array-map>             Path to a SmartStream array_map wasm file

    -e, --extra-params <extra-params>...
            (Optional) Extra input parameters passed to the smartstream module. They should be
            passed using key=value format Eg. fluvio consume topic-name --filter filter.wasm -E
            foo=bar -E key=value -E one=1

Add examples.

The docs should reinforce/reiterate the installer script's final instructions for adding ~/.fluvio/bin to the user's PATH

This should also be changed in the CLI help text, but we support

fluvio topic create testtopic --compression-type none --dry-run

fluvio topic create testtopic --compression-type gzip --dry-run

fluvio topic create testtopic --compression-type snappy --dry-run

fluvio topic create testtopic --compression-type lz4 --dry-run

• Elections
  • Which components participate in elections?
  • When do elections occur, and how are they conducted?
  • How do Fluvio elections compare with elections in other distributed systems?
• Storage
  • What is the layout of persisted objects?
  • How are checksums used?

We cross reference all over the site and also within pages with name anchors. However we are only using basic markdown for links. This means if we break a cross reference hyperlink, we know only if we happen to click on the broken link.

We should leverage Hugo's content management system and have it throw warnings or errors.

https://gohugo.io/content-management/cross-references/#readout

Right now, "Rust Filter API" is under the main SmartModules section and doesn't really belong. We should move it under the top-level API section

It's really easy to forget to update the newsletter list when we create a new post. This means we can accidentally orphan a This Week in Fluvio post, (especially with #184 forcing readers to rely on this list being accurate).

We have enough info about the post through the section organization of posts, and the front-matter that we can generate a new link whenever we add a new post.

Current docs cover the high-level project setup, but we could use a more detailed walkthrough where we provide an example connector project skeleton and have some example commands and outputs to set expectations for how to use connectors in development.

Similar to how we have a guide for how to use #[smartstream(filter)] (https://www.fluvio.io/docs/smartstreams/filter/), we need a guide for how to use #[smartstream(map)] now that it is implemented.

Document difference between Tier1, Tier2, CLI(k8)/Platform and supported OS

Both writing a new filter and consuming w/ --extra-params is needed in the docs.

Will be referenced in TWiF 11.

We want to list out Fluvio related libraries or code examples created by our users

For example, this go client is a contribution we want to share because we don't support the Go language officially.

As the project is growing and we have more documentation content we want to put on the website, we're realizing that the current hierarchy of doc pages is not the most natural fit to hold these contents in a clean and understandable way. I want to use this issue for us to collect some ideas of what we think the biggest areas of content are going to be in the coming year, and to brainstorm new possible page hierarchies for sorting that content.

Here are a few items I'm thinking of in terms of content:

• CLI docs
• Language clients
  • Including wasm client when we get there
• Smart streams
• Architecture
• Glossary
  • A section where we briefly explain common terms like "Topic" and "Partition" that are not unique to us but rather domain-specific

Add next steps -> Getting started
Be upfront w/ Linux/MacOS support using tabs (like Consul), but no windows

Fluvio Cloud specifies a 1GB storage limit, but does not describe the behavior of the system when it exceeds the limit. I think we should add documentation that describes the expected behavior when this occurs. For example should it:

• Refuse the newly-produced records and send an error response to the client?
• Roll the logs and drop the oldest records?

It seems to me like either of these options may be desirable, so we should make it configurable, though we should open a different issue for that. For this issue, we should identify the default behavior and figure out how and where to document it.

Depends on infinyon/fluvio-client-java#7.

This update corresponds to this PR adding JSON object formatting into a CLI table

infinyon/fluvio#1796

Today I have to click back in the browser, and select another post.

It would make it a lot easier to read all of the This Week in Fluvio posts if there were links that connected them together. This is particularly useful if people visit an older This Week in Fluvio post, in order to simply communicate that there are newer posts to read.

I was thinking we might test out placing them just at the bottom of the post?

Noticed this option in fluvio topic create

$ fluvio topic create -h
[...]
    -f, --replica-assignment <file.json>    Replica assignment file

I've never used this option before, and I don't know what the format should look like. No one else will be patient enough to figure this out, so we should show this off with an example.

We are going to launch the website with Architecture > Producer Behavior hidden.

Need to add detail to set expectations on Producer's behavior. There are some questions in the body that we should answer.

All tutorial on master branch should run with dev release of fluvio.
All tutorial on stable branch should run with latest release of fluvio.

This should be part of website CI.

This is especially important since v0.9.16 (the most recent version) has a default 7 day retention time for new topics.

We need a doc page on how to upgrade a Fluvio cluster. Right now we do not have an actual "upgrade" command, so the process is simply to fluvio cluster delete and then fluvio cluster start. Once we have upgrade implemented, we can update the doc to reflect the new process.

https://github.com/infinyon/fluvio-website/blob/master/content/docs/_index.md

It would be really nice if we could search over all of the docs.

I think this is just selecting a search library.

https://gohugo.io/tools/search/

We're going to need to update our docs to walk a user through how to load shell completions.

This connector has some updates that affect the existing docs and example output.

This week in Fluvio 18 will announce this feature, but the details for users to try on their own is needed.

Document what producer guarantee for fluvio

In This week in Fluvio #24 we walk through compiling Fluvio w/ WASI support.

This is a valuable workflow for a (very) technical user developing SmartModules, and it belongs somewhere in the docs so we don't lose it.

The current structure doesn't provide an obvious place for this to live, so this may need to wait for reorganization to occur first.

SmartStreams are now a core feature of Fluvio, but we don't mention them in the front docs page. We should add a section describing what they are.

We should also do some general upkeep such as describing new language clients that are now available rather than pending.

In the getting started tutorial for the Mac M1 it suggest using Kind and exposes the K8's cluster through various node ports.

The kind config suggest mapping ports in the 31xxx range but the default ports used by the helm charts are 30xxx as you can see here:
https://www.fluvio.io/docs/get-started/mac_m1/#start-a-kubernetes-cluster

The helm chart is using different ports seen here:
https://github.com/infinyon/fluvio/blob/d71161d76c15bf8646621eab7b264d1106e6f4b2/k8-util/helm/fluvio-app/values.yaml#L27

This tripped me up and took a little bit of debugging to get the cluster up and running.

I'm guessing the docs just need to be aligned with the helm chart. I'm happy to send a PR to update the docs?

Need docs to describe how to use CLI channels, also updates to how the installer script changed to utilize fluvio-channel as a frontend and how it installs the release channel specific fluvio binary.

This probably will go under the Installation section of the CLI docs. Perhaps within versions?

https://nightly.fluvio.io/cli/installation/versions/

update doc based on infinyon/fluvio#1363

Once we ship 0.7.2 of the fluvio client, we need a blog post announcing python

The new available behavior needs to be updated wrt the Rust API (maybe the CLI as well?)

https://github.com/infinyon/fluvio-client-python is getting cleaner and nearing "shipping" status so we need to write a post about it.

Now that we have good record-partitioning semantics, it makes sense for us to put together a tutorial page that describes how to leverage partitioning. Note that this does not yet assume multiple SPU. I imagine the topics we will want to cover are:

• How to create a topic with multiple partitions
• How do the various Producer APIs distribute records between partitions
• How to view the record count in each partition to see thing working
• How to consume records from the partitions

As convention, we want external links to open in another tab/window.

Shortcode should look similar to this:

<a href="{{ url }}" target="_blank">