From 57ef050b54368be26e1ab2be545de6ccf1136166 Mon Sep 17 00:00:00 2001 From: Amaechi johnkingsley <38525694+kizito917@users.noreply.github.com> Date: Wed, 27 Sep 2023 13:42:26 +0100 Subject: [PATCH 1/7] fix: typo on dashboard entry file [index.md] fixed (#15) * fix: typo on dashnboard entry file [index.md] fixed * fix: typo on endpoint file [endpoints.md] fixed * fix: typo on flows file [flows.md] fixed --- src/pages/en/dashboard/endpoints.md | 2 +- src/pages/en/dashboard/flows.md | 4 ++-- src/pages/en/dashboard/index.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/pages/en/dashboard/endpoints.md b/src/pages/en/dashboard/endpoints.md index bea4aa4..943a871 100644 --- a/src/pages/en/dashboard/endpoints.md +++ b/src/pages/en/dashboard/endpoints.md @@ -35,7 +35,7 @@ You can choose to add an endpoint to the auto-generated API docs by clicking on ## Remove from docs -Once an endpoint is already in your project's API documentations, you can remove an it from the API documentation by clicking on the dropdown menu on the top-right corner of the endpoint and click on **Remove from docs**. A confirmation modal will appear for you to click on **Confirm** if you want to proceed. +Once an endpoint is already in your project's API documentations, you can remove it from the API documentation by clicking on the dropdown menu on the top-right corner of the endpoint and click on **Remove from docs**. A confirmation modal will appear for you to click on **Confirm** if you want to proceed. > Once you remove an endpoint from the API documentation of your project, it will no longer be visible to anyone reading the API documentation for that project diff --git a/src/pages/en/dashboard/flows.md b/src/pages/en/dashboard/flows.md index 4831082..7ede49e 100644 --- a/src/pages/en/dashboard/flows.md +++ b/src/pages/en/dashboard/flows.md @@ -46,8 +46,8 @@ You can share a flow by clicking on the flow menu on the top right corner of a f ## Edit a flow -To edit a flow click on the flow menu on the top right corner of the flow and the click on **Edit**, a modal will pop up presenting you with a form to edit the flow's name and description. Click on **Save changes** when you are done to apply the changes you've made. +To edit a flow, click on the flow menu on the top right corner of the flow and the click on **Edit**, a modal will pop up presenting you with a form to edit the flow's name and description. Click on **Save changes** when you are done to apply the changes you've made. ## Delete a flow -To delete a flow click on the flow menu on the top-right corner of the flow and click on the **Delete** button. You will be presented with a confirmation modal. Click on **Confirm** on that modal to delete the flow. +To delete a flow, click on the flow menu on the top-right corner of the flow and click on the **Delete** button. You will be presented with a confirmation modal. Click on **Confirm** on that modal to delete the flow. diff --git a/src/pages/en/dashboard/index.md b/src/pages/en/dashboard/index.md index 38bee3a..6f7759e 100644 --- a/src/pages/en/dashboard/index.md +++ b/src/pages/en/dashboard/index.md @@ -14,8 +14,8 @@ In the dashboard you see a list of all your [projects](/en/dashboard/projects), You API keys is one of two pieces needed to integrate your codebase with a Treblle SDK, the second piece is your [Project ID](/en/dashboard/projects#project-id) -To locate you API key, in the Treblle Dashboard, on the top right hand of the navigation, you will find your profile avatar. Click on the avatar to get a dropdown and then click on **Account Settings**. +To locate your API key, in the Treblle Dashboard, on the top right hand of the navigation, you will find your profile avatar. Click on the avatar to get a dropdown and then click on **Account Settings**. > If you are logged in already in your Treblle Dashboard, you can click on this link to access your account settings -Once you are on your account settings page, you will find your API key on the top, simply click on the **Copy key** button to copy your API key. +Once you are on your account settings page, you will find your API key at the top, simply click on the **Copy key** button to copy your API key. From aa5ca4fecf4a226365a7a7523875e2bb8f3f9836 Mon Sep 17 00:00:00 2001 From: Lennox Charles Date: Wed, 27 Sep 2023 13:43:11 +0100 Subject: [PATCH 2/7] fix: typo error (#11) --- src/pages/en/integrations/django.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/en/integrations/django.mdx b/src/pages/en/integrations/django.mdx index a8262f6..3f4be9d 100644 --- a/src/pages/en/integrations/django.mdx +++ b/src/pages/en/integrations/django.mdx @@ -36,7 +36,7 @@ MIDDLEWARE_CLASSES = [ ## Getting started -Next, create a FREE account on [Treblle](https://treblle.com) to get an API key and Project ID. After you have those simply initialize Treblle in your **settinsg.py** file like so for django: +Next, create a FREE account on [Treblle](https://treblle.com) to get an API key and Project ID. After you have those simply initialize Treblle in your **settings.py** file like so for django: ```py TREBLLE_INFO = { From 47ebd7a831e75cf8939fd9df480cdf0139e23d0c Mon Sep 17 00:00:00 2001 From: Kelvin Oghenerhoro Omereshone Date: Thu, 28 Sep 2023 10:15:03 +0100 Subject: [PATCH 3/7] feat: add homepage (#17) --- astro.config.mjs | 1 - src/pages/index.astro | 42 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 src/pages/index.astro diff --git a/astro.config.mjs b/astro.config.mjs index f3b2fd2..823867d 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -34,7 +34,6 @@ export default defineConfig({ }, site: `https://docs.treblle.com`, redirects: { - '/': '/en/introduction', '/en/integrations/dotnet': '/en/integrations/net', '/en/integrations/rails': '/en/integrations/ruby', '/en/integrations/dotnet-core': '/en/integrations/net-core', diff --git a/src/pages/index.astro b/src/pages/index.astro new file mode 100644 index 0000000..21b1328 --- /dev/null +++ b/src/pages/index.astro @@ -0,0 +1,42 @@ +--- +import TreblleIntegrations from '../components/TreblleIntegrations.astro' +import HeadCommon from '../components/HeadCommon.astro' +import Header from '../components/Header/Header.astro' + +const currentPage = Astro.url.pathname +--- + + + + Home + +
+
+

Treblle Documentation

+

+ Treblle is an easy-to-use SDK that helps Engineering and Product teams + create and manage REST APIs more quickly. +

+
+ + Get started with API monitoring + + + Explore integrations + +
+
+
+

Pick your platform...

+

...and get started in minutes.

+ +
+
From 7bcf3986c91df74b2f0e80d2b444d8cc95466981 Mon Sep 17 00:00:00 2001 From: Kelvin Oghenerhoro Omereshone Date: Thu, 28 Sep 2023 10:16:00 +0100 Subject: [PATCH 4/7] chore: bump version number --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 347af1e..149ccf6 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "treblle-docs", "type": "module", - "version": "0.2.10", + "version": "0.3.0", "private": true, "scripts": { "dev": "astro dev", From c503bb57cc8494f71ce715ff241740e43a863753 Mon Sep 17 00:00:00 2001 From: Mo Shehu <40317687+shehuphd@users.noreply.github.com> Date: Wed, 27 Sep 2023 13:47:46 +0100 Subject: [PATCH 5/7] Update who-is-treblle-for.md (#14) Fixed repetition --- src/pages/en/who-is-treblle-for.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/pages/en/who-is-treblle-for.md b/src/pages/en/who-is-treblle-for.md index 355a8e6..4b70def 100644 --- a/src/pages/en/who-is-treblle-for.md +++ b/src/pages/en/who-is-treblle-for.md @@ -31,10 +31,9 @@ If your role is one of the following listed below, Treblle is a great tool to ha - QA engineers - Engineering managers and leaders - DevOps managers +- DevOps engineers - Product managers - API product managers - CTOs & CIOs - Technical leads -- DevOps engineers -- Mobile developers - Web developers From a55f96c2231b74efaaca72cf3cdc18900820cc08 Mon Sep 17 00:00:00 2001 From: Kelvin Oghenerhoro Omereshone Date: Mon, 9 Oct 2023 10:23:34 +0100 Subject: [PATCH 6/7] docs: add docs for Platformatic DB (#21) --- src/pages/en/integrations/fastify.mdx | 60 +++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/src/pages/en/integrations/fastify.mdx b/src/pages/en/integrations/fastify.mdx index fe61a8d..4551588 100644 --- a/src/pages/en/integrations/fastify.mdx +++ b/src/pages/en/integrations/fastify.mdx @@ -61,6 +61,66 @@ fastiy.register(treblleFastify, { }) ``` +## Platformatic DB + +Since the Treblle SDK for Fastify is a Fastify plugin, you can easily set up Treblle in a [Platformatic DB](https://docs.platformatic.dev/docs/reference/db/introduction) application with the following steps: + +### install the SDK + +Run the below command to install the Treblle SDK in your Platformatic DB project + +```sh +npm i @treblle/fastify --save +``` + +### Setup environment variables + +In your `.env` file, add the following environment variables for your Treblle API Key and Project ID respectively: + +- `PLT_TREBLLE_API_KEY` +- `PLT_TREBLLE_PROJECT_ID` + +### Add plugin options + +Next edit your `platformatic.db.json` config file to have an `options` property with environment variable placeholders for the Treblle credentials you set earlier in your `.env` file: + +```json +"plugins": { + "paths": [ + { + "path": "./plugins", + "encapsulate": false, + "options": { + "treblleApiKey": "{PLT_TREBLLE_API_KEY}", + "treblleProjectId": "{PLT_TREBLLE_PROJECT_ID}" + } + }, + { + "path": "./routes" + } + ] + }, +``` + +### Setup the plugin + +To setup the plugin create `treblle.js` file in `plugins/` folder and add the below code: + +```js +/// +'use strict' +/** @param {import('fastify').FastifyInstance} fastify */ +module.exports = async function (fastify, opts) { + const treblleFastify = require('@treblle/fastify') + fastify.register(treblleFastify, { + apiKey: opts.treblleApiKey, + projectId: opts.treblleProjectId, + }) +} +``` + +Now when a request comes into your Platformatic DB app, it will get sent to your Treblle dashboard. + ## More Integrations From 2b1741e040df9bec37a26769ae1941a258209eb7 Mon Sep 17 00:00:00 2001 From: Kelvin Oghenerhoro Omereshone Date: Mon, 9 Oct 2023 10:24:48 +0100 Subject: [PATCH 7/7] chore: 0.3.1 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 149ccf6..2d8206c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "treblle-docs", "type": "module", - "version": "0.3.0", + "version": "0.3.1", "private": true, "scripts": { "dev": "astro dev",