From e92821da9ca2b4172671ac7a88fb980b2d31934b Mon Sep 17 00:00:00 2001 From: David Boyne Date: Wed, 31 Jul 2024 16:39:47 +0100 Subject: [PATCH] docs(docs): added new docs attribute to each winglib package file (#302) * adding docs for winglibs for doc automation on docsite * adding docs for winglibs for doc automation on docsite --------- Co-authored-by: David Boyne --- bedrock/package.json | 7 ++++++- budget/README.md | 2 +- budget/package.json | 6 +++++- checks/package.json | 6 +++++- cognito/package.json | 6 +++++- containers/package.json | 6 +++++- dynamodb/package.json | 6 +++++- eventbridge/package.json | 6 +++++- fifoqueue/package.json | 6 +++++- github/package.json | 6 +++++- jwt/package.json | 6 +++++- k8s/package.json | 6 +++++- lock/package.json | 6 +++++- messagefanout/package.json | 6 +++++- momento/package.json | 6 +++++- ngrok/package.json | 6 +++++- openai/package.json | 6 +++++- postgres/package.json | 6 +++++- python/package.json | 6 +++++- react/package.json | 6 +++++- redis/package.json | 7 ++++++- sagemaker/package.json | 6 +++++- ses/package.json | 6 +++++- simtools/package.json | 6 +++++- slack/package.json | 6 +++++- sns/README.md | 2 +- sns/package.json | 8 ++++++-- tf/package.json | 6 +++++- tsoa/package.json | 6 +++++- vite/package.json | 6 +++++- websockets/package.json | 6 +++++- 31 files changed, 150 insertions(+), 32 deletions(-) diff --git a/bedrock/package.json b/bedrock/package.json index 24f76364..73c13c4c 100644 --- a/bedrock/package.json +++ b/bedrock/package.json @@ -16,7 +16,12 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "Amazon Bedrock", + "summary": "A Wing library for Amazon Bedrock", + "demoURL": "http://winglang.io/docs/examples/basic-auth-api" + } }, "peerDependencies": { "@aws-sdk/client-bedrock-runtime": "^3.484.0" diff --git a/budget/README.md b/budget/README.md index 06b07d9d..b41bf25c 100644 --- a/budget/README.md +++ b/budget/README.md @@ -18,7 +18,7 @@ npm i @winglibs/budget Add your budget alert to the code: -```wing +```js bring budget; new budget.Alert( diff --git a/budget/package.json b/budget/package.json index dcccd978..1055b9f3 100644 --- a/budget/package.json +++ b/budget/package.json @@ -24,6 +24,10 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "AWS Budget", + "summary": "A Wing library for working with [AWS Budgets]" + } } } diff --git a/checks/package.json b/checks/package.json index 8e2ba5b1..e91bdf9a 100644 --- a/checks/package.json +++ b/checks/package.json @@ -23,7 +23,11 @@ "wing": { "platforms": [ "*" - ] + ], + "docs": { + "title": "Cloud checks", + "summary": "A self-validation mechanism for cloud applications" + } }, "license": "MIT" } diff --git a/cognito/package.json b/cognito/package.json index 6221ec1b..a500f42a 100644 --- a/cognito/package.json +++ b/cognito/package.json @@ -21,7 +21,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "Amazon Cognito", + "summary": "A wing library to work with Amazon Cognito" + } }, "license": "MIT" } diff --git a/containers/package.json b/containers/package.json index 5ab9f605..fdf63c8e 100644 --- a/containers/package.json +++ b/containers/package.json @@ -15,7 +15,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "Containers", + "summary": "Deploy containers with Wing" + } }, "license": "MIT", "peerDependencies": { diff --git a/dynamodb/package.json b/dynamodb/package.json index 487dba39..3624afb3 100644 --- a/dynamodb/package.json +++ b/dynamodb/package.json @@ -19,7 +19,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "Amazon DynamoDB", + "summary": "A Wing library for Amazon DynamoDB" + } }, "license": "MIT", "peerDependencies": { diff --git a/eventbridge/package.json b/eventbridge/package.json index 1764c32f..de1b86cc 100644 --- a/eventbridge/package.json +++ b/eventbridge/package.json @@ -17,7 +17,11 @@ "sim", "tf-aws", "awscdk" - ] + ], + "docs": { + "title": "Amazon EventBridge", + "summary": "A Wing library for working with Amazon EventBridge" + } }, "peerDependencies": { "@aws-sdk/client-eventbridge": "^3.525.0", diff --git a/fifoqueue/package.json b/fifoqueue/package.json index 36522233..7b8e0e7f 100644 --- a/fifoqueue/package.json +++ b/fifoqueue/package.json @@ -20,7 +20,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "FIFO Queue", + "summary": "A wing library to work with FIFO (first-in first-out) Queues" + } }, "license": "MIT" } diff --git a/github/package.json b/github/package.json index a2d30ece..da9a8ad6 100644 --- a/github/package.json +++ b/github/package.json @@ -15,7 +15,11 @@ "wing": { "platforms": [ "*" - ] + ], + "docs": { + "title": "GitHub", + "summary": "A wing library to work with GitHub Probot" + } }, "peerDependencies": { "@probot/adapter-aws-lambda-serverless": "^3.0.4", diff --git a/jwt/package.json b/jwt/package.json index 3c00cf7e..929b27f6 100644 --- a/jwt/package.json +++ b/jwt/package.json @@ -14,7 +14,11 @@ "wing": { "platforms": [ "*" - ] + ], + "docs": { + "title": "JWT authentication", + "summary": "Wing library for JWT authentication" + } }, "license": "MIT", "peerDependencies": { diff --git a/k8s/package.json b/k8s/package.json index 9cd5fa86..aa5001f4 100644 --- a/k8s/package.json +++ b/k8s/package.json @@ -14,7 +14,11 @@ "wing": { "platforms": [ "k8s" - ] + ], + "docs": { + "title": "Kubernetes (k8s)", + "summary": "Wing for Kubernetes" + } }, "license": "MIT", "peerDependencies": { diff --git a/lock/package.json b/lock/package.json index 7f1fdb1b..3914faef 100644 --- a/lock/package.json +++ b/lock/package.json @@ -14,7 +14,11 @@ "wing": { "platforms": [ "*" - ] + ], + "docs": { + "title": "Lock", + "summary": "Wing library for cloud lock" + } }, "license": "MIT" } diff --git a/messagefanout/package.json b/messagefanout/package.json index 960a359b..d0f49e7a 100644 --- a/messagefanout/package.json +++ b/messagefanout/package.json @@ -16,7 +16,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "Message Fanout", + "summary": "Wing library to fan out messages" + } }, "peerDependencies": { "@aws-sdk/client-sns": "^3.511.0", diff --git a/momento/package.json b/momento/package.json index a358591a..391b0c93 100644 --- a/momento/package.json +++ b/momento/package.json @@ -17,7 +17,11 @@ "tf-aws", "tf-gcp", "tf-azure" - ] + ], + "docs": { + "title": "Momento", + "summary": "Wing library for [momento](https://www.gomomento.com/)" + } }, "license": "MIT", "peerDependencies": { diff --git a/ngrok/package.json b/ngrok/package.json index 72202e26..e9afbf1c 100644 --- a/ngrok/package.json +++ b/ngrok/package.json @@ -14,7 +14,11 @@ "wing": { "platforms": [ "*" - ] + ], + "docs": { + "title": "ngrok", + "summary": "Wing library for [ngrok](https://ngrok.com/). Create local tunnels to Wing endpoints." + } }, "license": "MIT", "peerDependencies": { diff --git a/openai/package.json b/openai/package.json index b07165ba..5179daa7 100644 --- a/openai/package.json +++ b/openai/package.json @@ -15,7 +15,11 @@ "wing": { "platforms": [ "*" - ] + ], + "docs": { + "title": "OpenAI", + "summary": "Wing library for [OpenAI](https://openai.com/)" + } }, "peerDependencies": { "openai": "^4.28.4" diff --git a/postgres/package.json b/postgres/package.json index 13495222..1609b516 100644 --- a/postgres/package.json +++ b/postgres/package.json @@ -22,7 +22,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "Postgres", + "summary": "Wing library for [Postgres](https://www.postgresql.org/)" + } }, "license": "MIT" } diff --git a/python/package.json b/python/package.json index 04f97c5a..7ae0dd1b 100644 --- a/python/package.json +++ b/python/package.json @@ -15,7 +15,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "Python", + "summary": "A Wing library for running [Python](https://www.python.org/) code in [inflight](https://www.winglang.io/docs/concepts/inflights#inflight-code)." + } }, "license": "MIT", "peerDependencies": { diff --git a/react/package.json b/react/package.json index 01a4b6f3..fc9c68fd 100644 --- a/react/package.json +++ b/react/package.json @@ -15,7 +15,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "React", + "summary": "A Wing library for [React](https://react.dev/)" + } }, "license": "MIT", "peerDependencies": { diff --git a/redis/package.json b/redis/package.json index 9dfa8d11..55d0c4fb 100644 --- a/redis/package.json +++ b/redis/package.json @@ -14,7 +14,12 @@ "wing": { "platforms": [ "sim" - ] + ], + "docs": { + "title": "Redis", + "summary": "A Wing library for [Redis](https://redis.io/)", + "demoURL": "https://www.winglang.io/docs/examples/redis" + } }, "license": "MIT", "peerDependencies": { diff --git a/sagemaker/package.json b/sagemaker/package.json index 56753b2d..43b86e1e 100644 --- a/sagemaker/package.json +++ b/sagemaker/package.json @@ -15,7 +15,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "Amazon SageMaker", + "summary": "The library enables owners of a trained sagemaker model, to access its Endpoints from a winglang [inflight](https://www.winglang.io/docs/concepts/inflights#inflight-code) code." + } }, "license": "MIT", "peerDependencies": { diff --git a/ses/package.json b/ses/package.json index c9028463..c139bb5d 100644 --- a/ses/package.json +++ b/ses/package.json @@ -15,7 +15,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "Amazon SES", + "summary": "Wing library for interacting with Amazon SES." + } }, "license": "MIT", "peerDependencies": { diff --git a/simtools/package.json b/simtools/package.json index ff109d37..311ec8cb 100644 --- a/simtools/package.json +++ b/simtools/package.json @@ -14,7 +14,11 @@ "wing": { "platforms": [ "sim" - ] + ], + "docs": { + "title": "Wing simulator utils", + "summary": "[Wing simulator](https://www.winglang.io/docs/platforms/sim) utility library" + } }, "license": "MIT" } diff --git a/slack/package.json b/slack/package.json index 3059ae2a..21e11df3 100644 --- a/slack/package.json +++ b/slack/package.json @@ -18,7 +18,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "Slack", + "summary": "A Wing library for working with [Slack](https://slack.com/)" + } }, "license": "MIT" } \ No newline at end of file diff --git a/sns/README.md b/sns/README.md index 9ebac002..41ea9de4 100644 --- a/sns/README.md +++ b/sns/README.md @@ -1,6 +1,6 @@ # sns -This library allows you to interact with the AWS SNS Service. +This library allows you to interact with the Amazon SNS Service. ## Prerequisites diff --git a/sns/package.json b/sns/package.json index 5dba8dad..70515c85 100644 --- a/sns/package.json +++ b/sns/package.json @@ -1,6 +1,6 @@ { "name": "@winglibs/sns", - "description": "Wing library for interacting with AWS SNS", + "description": "Wing library for interacting with Amazon SNS", "version": "0.1.3", "repository": { "type": "git", @@ -16,7 +16,11 @@ "tf-aws", "awscdk", "sim" - ] + ], + "docs": { + "title": "Amazon SNS", + "summary": "A Wing library for working with [Amazon SNS](https://aws.amazon.com/sns/)" + } }, "license": "MIT", "peerDependencies": { diff --git a/tf/package.json b/tf/package.json index c319e5e7..57a2451c 100644 --- a/tf/package.json +++ b/tf/package.json @@ -15,7 +15,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "Terraform utilities", + "summary": "Terraform utilities library for Wing" + } }, "license": "MIT", "peerDependencies": { diff --git a/tsoa/package.json b/tsoa/package.json index 85c7b426..01037054 100644 --- a/tsoa/package.json +++ b/tsoa/package.json @@ -14,7 +14,11 @@ "wing": { "platforms": [ "sim" - ] + ], + "docs": { + "title": "tsoa", + "summary": "A Wing library for working with [TSOA](https://tsoa-community.github.io/docs/) - An OpenAPI-compliant Web APIs using TypeScript." + } }, "license": "MIT", "peerDependencies": { diff --git a/vite/package.json b/vite/package.json index ef0b7846..cb2013ca 100644 --- a/vite/package.json +++ b/vite/package.json @@ -21,7 +21,11 @@ "platforms": [ "sim", "tf-aws" - ] + ], + "docs": { + "title": "Vite", + "summary": "A Wing library to deploy [Vite applications](https://vitejs.dev/) to the cloud." + } }, "peerDependencies": { "@cdktf/provider-aws": "^19.12.0", diff --git a/websockets/package.json b/websockets/package.json index abf3d6aa..d494df31 100644 --- a/websockets/package.json +++ b/websockets/package.json @@ -25,7 +25,11 @@ "sim", "tf-aws", "awscdk" - ] + ], + "docs": { + "title": "WebSocket", + "summary": "A Wing library that enables you to create WebSockets using Wing." + } }, "devDependencies": { "@types/ws": "^8.5.10",