nitrictech / docs Goto Github PK

Improve testing for docs on production site

Add ability to create multiple doc sidebars.

So we can separate docs into different sidebars to reduce clutter. For example a guides sidebar.

Let's provide more guidance on how to use existing database technologies with Nitric. Some great examples would be Postgres, MySql, PlanetScale, Redis and MongoDB.

Document the new Secret Service plugin

All provider docs still say key/value, should be document service

Update tensor flow tutorial to use new cli

Help user by writting a guide on how to write full e2e or their application.
Show examples of what the tests might look like.

Add testing for docs mdx files to ensure they don't break.

This could be linting and / or compiling.

Provide an introductory REST API tutorial for Nitric, which is useful for a developer who is new to Nitric as a way to get started.

Explain what the pre-requisits are for so that people know why they are installing them.

Add an Encryption Data Keys example based on the illustrative code in the docs/secrets.mdx

Consolidate SDK Examples to supported languages/runtimes: Node, Python, Java, Go

Following the steps in the secrets page results with the following run-time error when attempting to use the secrets

Secret plugin not registered

Observed in Local nitric run.
Steps should be added to instruct users on how to register the Secrets plugin.

Documentation updates to support local development changes in:
nitrictech/cli#359

https://nitric.io/docs/reference/providers/gcp/configuration have some links to 404 google docs

There has been a strong preference to use environment variable to store configuration data such as API keys. Let's enhance the docs to make it clear how to use environment variables for local development and how to deploy them with nitric up

Should this be !stripeWebhookSecret?

Code snippets in docs get stale easily the way they're currently included directly in the mdx files. Docs instead should be real, working, tested code which is then referenced within the mdx files. This will ensure every snippet genuinely works and allow tests to break when breaking changes mean an example update is required.

GCP provides good snippet documentation using a similar strategy, we should look there for examples.

Bug Report

Missing nav links for http resource in node.

Now that we have updated issue templates and the "info" command in the CLI, let's update https://nitric.io/docs/support/bug-report#best-practices-for-writing-the-bug-report to reflect the current process.

• basics - quick-start
• projects

As a developer working with Nitric
I want access to a guide for github actions
Which I can use or clone to handle deployments to AWS

Coverage should be adequate with a guide for AWS, however mention that converting to some other cloud would be just as easy with minor tweaks.

The depth of any text created to support this documentation shouldn't be a long read -
Take inspiration from -

https://www.prisma.io/docs/guides/deployment/deployment-guides/deploying-migrations-from-a-local-environment#local-cicd-pipeline

We've added functionality for adding config settings to functions -

Add or improve the docs on what these config options are , with examples.

Help user by writting a guide on how to write a unit test for their application.
Show examples of what the tests might look like.

Add spellcheck to ci tests, this will ensure any spelling errors or typos are found.
We can generate a dictionary to add ignored words.

From Elisse:

I'm pretty sure Rak had a PR for this, but I can't seem to find it... can anyone else?

These two pages:

https://nitric.io/docs/reference/csharp/v0/storage/bucket
https://nitric.io/docs/reference/csharp/v0/storage/bucket-file

Have links to:
file.signUrl()

that results in a 404.