conduitio/conduit-site

conduit-site's Issues

refactor: remove guides section and move some content to documentation

Our guides section seem not to have all the attention needed, and we're investing more time into our main documentation section.

Let's remove the guide section and move the two guides that could be useful to /docs:

• Stream inspector
• Kafka connect wrapper

Remove backticks for code

In situations where you want to use backticks in markdown to show fixed with fonts, the backticks continue to show up on the rendered page.

Need to remove the backticks

Feature: add an algolia search bar to the docs

Feature description

Just like the meroxa docs:
https://docs.meroxa.com/

It makes the docs much more approachable.

Add examples for built-in processors

The docs for built-in processors are missing examples.

Automatically update list of connectors

The list of connectors on our website (link) is taken from connectors.json that is manually built using a script.

We should automate this process and let it run periodically. The expected output should be a pull request, that is merged if it's deemed "safe" (definition of "safe" TBD but generally it's about preventing unintentional updates).

Add detail to pipeline file specification

The pipeline specification documentation only gives basic information about fields.

For instance the pipeline id field. Only has the following information:

Data Type: String
Required: Yes
Default: None
<SNIP>

If you look that the code you'll see that there are only certain characters allowed and there's a length limit.
https://github.com/ConduitIO/conduit/blob/cea8874345beed93ff10634ede6401a2c56a1afb/pkg/pipeline/service.go#L30-L36

We should just have this info in the spec so someone doesn't need to go to the code to look it up.

Background color needed for top 4 boxes on site

See Figma file here for how the second section of the page with the 4 boxes should look:
https://www.figma.com/file/nJDVa6K1nIZwp214PLVMWN/Landing-Pages?node-id=2146%3A232

Color is Tailwind Teal 600 @60% (#00897B @60%)