From 2a602e50d6b55db529022aba8362f36cc2a85bbb Mon Sep 17 00:00:00 2001 From: commit111 Date: Tue, 8 Oct 2024 14:52:57 -0700 Subject: [PATCH 1/3] added periods to Short Descriptions --- samples/django/README.md | 2 +- samples/fastapi-postgres/README.md | 2 +- samples/golang-mongodb-atlas/README.md | 4 ++-- samples/huginn/README.md | 2 +- samples/nocodb/README.md | 2 +- samples/pulumi/README.md | 4 ++-- samples/vllm/README.md | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/samples/django/README.md b/samples/django/README.md index 90604952..1d7ff634 100644 --- a/samples/django/README.md +++ b/samples/django/README.md @@ -35,7 +35,7 @@ The Dockerfile and compose files are already set up for you and are ready to be Title: Django -Short Description: A simple Django app that uses SQLite as the database +Short Description: A simple Django app that uses SQLite as the database. Tags: Django, SQLite, Python diff --git a/samples/fastapi-postgres/README.md b/samples/fastapi-postgres/README.md index 8598f41d..7c8744e1 100644 --- a/samples/fastapi-postgres/README.md +++ b/samples/fastapi-postgres/README.md @@ -23,7 +23,7 @@ This sample project demonstrates how to deploy FastAPI with PostgreSQL with Defa Title: FastAPI & PostgreSQL -Short Description: A sample project with FastAPI and PostgreSQL +Short Description: A sample project with FastAPI and PostgreSQL. Tags: FastAPI, PostgreSQL, Python, SQL diff --git a/samples/golang-mongodb-atlas/README.md b/samples/golang-mongodb-atlas/README.md index 09d56263..866e3d0b 100644 --- a/samples/golang-mongodb-atlas/README.md +++ b/samples/golang-mongodb-atlas/README.md @@ -37,8 +37,8 @@ Environment: Designed to run in containerized environments using Docker, which e Title: Go & MongoDB Atlas -Short Description: A simple Go application that manages tasks with MongoDB Atlas +Short Description: A simple Go application that manages tasks with MongoDB Atlas. -Tags: Go, MongoDB, Atlas, Task manager +Tags: Go, MongoDB, Atlas, Task Manager Languages: golang diff --git a/samples/huginn/README.md b/samples/huginn/README.md index 34b20ded..803c2396 100644 --- a/samples/huginn/README.md +++ b/samples/huginn/README.md @@ -27,7 +27,7 @@ To start the local environment, run `docker compose -f ./compose.yaml -f ./compo Title: Huginn -Short Description: A system for building agents that perform automated tasks for you online +Short Description: A system for building agents that perform automated tasks for you online. Tags: Huginn, Agents, Automation diff --git a/samples/nocodb/README.md b/samples/nocodb/README.md index 570d2c59..81b2608e 100644 --- a/samples/nocodb/README.md +++ b/samples/nocodb/README.md @@ -57,7 +57,7 @@ For development, we use a local postgres container and a volume mount for file u Title: NocoDB -Short Description: An open source alternative to AirTable +Short Description: An open source alternative to AirTable. Tags: NocoDB diff --git a/samples/pulumi/README.md b/samples/pulumi/README.md index 7c9fbe70..a8d87492 100644 --- a/samples/pulumi/README.md +++ b/samples/pulumi/README.md @@ -38,8 +38,8 @@ pulumi up Title: Pulumi -Short Description: A basic Pulumi example +Short Description: A basic Pulumi example. -Tags: pulumi, Node.js, http, server, TypeScript +Tags: Pulumi, Node.js, http, Server, TypeScript Languages: nodejs diff --git a/samples/vllm/README.md b/samples/vllm/README.md index 1a15154f..38702639 100644 --- a/samples/vllm/README.md +++ b/samples/vllm/README.md @@ -45,7 +45,7 @@ By following these steps, you should be able to deploy Mistral along with a cust Title: Mistral & vLLM -Short Description: Deploy Mistral with a custom UI using vLLM +Short Description: Deploy Mistral with a custom UI using vLLM. Tags: Mistral, vLLM, AI, Nextjs, GPU, Node.js, TypeScript, JavaScript From 5e42482adcb0bfc5ffbd09f218e5610c998164b9 Mon Sep 17 00:00:00 2001 From: commit111 Date: Tue, 8 Oct 2024 14:56:06 -0700 Subject: [PATCH 2/3] revised certain tags/words to be consistent in capitalization with other samples --- samples/golang-rest-api/README.md | 2 +- samples/javalin/README.md | 2 +- samples/pulumi-remix-postgres/README.md | 2 +- samples/python-form/README.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/samples/golang-rest-api/README.md b/samples/golang-rest-api/README.md index 87600505..40e0d7ca 100644 --- a/samples/golang-rest-api/README.md +++ b/samples/golang-rest-api/README.md @@ -10,6 +10,6 @@ Title: Go & REST API Short Description: A simple Go application that fetches fiscal data from an API. -Tags: Go, http, Fiscal data, REST API +Tags: Go, http, Fiscal Data, REST API Languages: golang diff --git a/samples/javalin/README.md b/samples/javalin/README.md index 66d94659..3adedde4 100644 --- a/samples/javalin/README.md +++ b/samples/javalin/README.md @@ -28,7 +28,7 @@ docker compose up --build Title: Javalin -Short Description: A short hello world application demonstrating how to deploy Javalin onto defang. +Short Description: A short hello world application demonstrating how to deploy Javalin onto Defang. Tags: Javalin, Java, Maven diff --git a/samples/pulumi-remix-postgres/README.md b/samples/pulumi-remix-postgres/README.md index c0373048..8b16da87 100644 --- a/samples/pulumi-remix-postgres/README.md +++ b/samples/pulumi-remix-postgres/README.md @@ -45,6 +45,6 @@ Title: Pulumi & Remix & PostgreSQL Short Description: A full-stack example using Remix, Prisma, and Aiven. -Tags: Full stack, Remix, Prisma, Aiven, PostgreSQL, Pulumi, Node.js, TypeScript, SQL +Tags: Full-stack, Remix, Prisma, Aiven, PostgreSQL, Pulumi, Node.js, TypeScript, SQL Languages: nodejs diff --git a/samples/python-form/README.md b/samples/python-form/README.md index daa5afac..1e620cc8 100644 --- a/samples/python-form/README.md +++ b/samples/python-form/README.md @@ -24,8 +24,8 @@ This Flask application provides a basic example of handling form submissions. It Title: Python & Form -Short Description: A short python example for form submission in flask. +Short Description: A short Python example for form submission in Flask. -Tags: Python, Flask, form +Tags: Python, Flask, Form Languages: python From a3a6b4f3ac0357b2f27617e6e0c3f996c44ed74f Mon Sep 17 00:00:00 2001 From: commit111 Date: Tue, 8 Oct 2024 14:57:24 -0700 Subject: [PATCH 3/3] changed language to be nodejs so it shows up in CLI --- samples/html-css-js/README.md | 2 +- samples/vuejs/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/samples/html-css-js/README.md b/samples/html-css-js/README.md index e8b5d26b..3c59ed41 100644 --- a/samples/html-css-js/README.md +++ b/samples/html-css-js/README.md @@ -32,4 +32,4 @@ Short Description: A simple HTML + CSS + JavaScript website running on Defang. Tags: HTML, CSS, JavaScript, Frontend -Languages: HTML, CSS, JavaScript +Languages: nodejs diff --git a/samples/vuejs/README.md b/samples/vuejs/README.md index 3bb3c5cc..cbea35d0 100644 --- a/samples/vuejs/README.md +++ b/samples/vuejs/README.md @@ -32,5 +32,5 @@ Short Description: A minimal Vue.js app running on Defang. Tags: Vue.js, Vite, Node.js, Frontend, JavaScript -Languages: javascript +Languages: nodejs