From 417a87cf21a09a4a7a69b35bcf04d5ccd9fe8767 Mon Sep 17 00:00:00 2001 From: Thada Wangthammang Date: Wed, 8 May 2024 17:42:27 +0700 Subject: [PATCH] doc(nammatham): update doc & github links --- ... 2024-05-08-release-nammatham-doc-site.md} | 0 apps/nammatham/docs/intro.md | 32 ++++++++++++++----- apps/nammatham/docusaurus.config.ts | 8 ++--- 3 files changed, 28 insertions(+), 12 deletions(-) rename apps/nammatham/blog/{2019-05-29-long-blog-post.md => 2024-05-08-release-nammatham-doc-site.md} (100%) diff --git a/apps/nammatham/blog/2019-05-29-long-blog-post.md b/apps/nammatham/blog/2024-05-08-release-nammatham-doc-site.md similarity index 100% rename from apps/nammatham/blog/2019-05-29-long-blog-post.md rename to apps/nammatham/blog/2024-05-08-release-nammatham-doc-site.md diff --git a/apps/nammatham/docs/intro.md b/apps/nammatham/docs/intro.md index 2e3cd5e..ae0c61b 100644 --- a/apps/nammatham/docs/intro.md +++ b/apps/nammatham/docs/intro.md @@ -2,22 +2,38 @@ sidebar_position: 1 --- +:::warning + +This is documentation for Nammatham 1.x, which is no longer actively maintained. + +For up-to-date documentation, see the [latest version](https://github.com/thaitype/nammatham/blob/main/README.md) (2.x). + +::: + + + +

+ Nammatham Logo +

+ # Introduction Azure Function Lightweight frameworks with DI, providing type safe function triggers and bindings +[![Build & Test](https://github.com/thaitype/nammatham/actions/workflows/test.yml/badge.svg)](https://github.com/thaitype/nammatham/actions/workflows/test.yml?branch=v1.x) [![codecov](https://codecov.io/gh/thaitype/nammatham/branch/main/graph/badge.svg?token=Y7ZMDKFPAN)](https://codecov.io/gh/thaitype/nammatham) [![npm version](https://img.shields.io/npm/v/nammatham)](https://www.npmjs.com/package/nammatham) [![npm download](https://img.shields.io/npm/dt/nammatham)](https://www.npmjs.com/package/nammatham) -| Version | Status | Azure Functions Node.js | branch | -| ------- | ----------- | ----------------------- | ------ | -| v1.x | Maintenance | v3.x | v1.x | -| v2.x | Alpha | v4.x | main | -> **Nammatham** v1 is stable now (I've currently used in production), due to Nammatham v1 is based on Azure Functions Node.js v3.5.x. Azure will release Azure Functions Node.js v4 in GA (General availability) soon, [See in Roadmap 2023](https://github.com/Azure/azure-functions-nodejs-library/wiki/Roadmap) -> -> **Nammatham** v2 is [currently in development](https://github.com/thaitype/nammatham/issues/77), it will based on Azure Functions Node.js v4. [Tracking issue Nammatham supported with v4](https://github.com/thaitype/nammatham/issues?q=is%3Aissue+is%3Aopen+label%3Afunc-v4) -> +| Version | Status | Azure Functions Node.js Lib | Branch | Build Status | +| ------- | ----------- | ------------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| v1.x | Maintenance | v3.x | [v1.x][v1.x] | [![Build & Test](https://github.com/thaitype/nammatham/actions/workflows/test.yml/badge.svg?branch=v1.x)](https://github.com/thaitype/nammatham/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/thaitype/nammatham/branch/v1.x/graph/badge.svg?token=Y7ZMDKFPAN)](https://codecov.io/gh/thaitype/nammatham) | +| v2.x | Alpha | v4.x | [main][main] | [![Build & Test](https://github.com/thaitype/nammatham/actions/workflows/test.yml/badge.svg?branch=main.unittest)](https://github.com/thaitype/nammatham/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/thaitype/nammatham/branch/main/graph/badge.svg?token=Y7ZMDKFPAN)](https://codecov.io/gh/thaitype/nammatham) | +[v1.x]: https://github.com/thaitype/nammatham/tree/v1.x +[main]: https://github.com/thaitype/nammatham/tree/main +> Please note that Nammatham v2 is currently in its Alpha stage and is intended for internal use only. As we actively develop and refine the platform, be aware that the API may undergo frequent changes. [Tracking v2 Roadmap](https://github.com/thaitype/nammatham/issues?q=is%3Aissue+is%3Aopen+label%3Av2-blocker) +> +> Note: [Nammatham v1](https://www.npmjs.com/package/nammatham) is currently in maintenance mode. no new features are actively being developed ## Description Nammatham (นามธรรม in Thai, pronounced `/naam ma tham/`, means **abstract** in Thai) is Azure Function Nodejs Lightweight framework with Dependency Injection. Provide type safety wrapping `function.json` diff --git a/apps/nammatham/docusaurus.config.ts b/apps/nammatham/docusaurus.config.ts index 9a60829..7b6e4b4 100644 --- a/apps/nammatham/docusaurus.config.ts +++ b/apps/nammatham/docusaurus.config.ts @@ -38,14 +38,14 @@ const config: Config = { // Please change this to your repo. // Remove this to remove the "edit this page" links. editUrl: - 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + 'https://github.com/thaitype/thaitype.github.io/tree/main/apps/nammatham/', }, blog: { showReadingTime: true, // Please change this to your repo. // Remove this to remove the "edit this page" links. editUrl: - 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + 'https://github.com/thaitype/thaitype.github.io/tree/main/apps/nammatham/', }, theme: { customCss: './src/css/custom.css', @@ -72,7 +72,7 @@ const config: Config = { }, { to: '/blog', label: 'Blog', position: 'left' }, { - href: 'https://github.com/facebook/docusaurus', + href: 'https://github.com/thaitype/nammatham', label: 'GitHub', position: 'right', }, @@ -116,7 +116,7 @@ const config: Config = { }, { label: 'GitHub', - href: 'https://github.com/facebook/docusaurus', + href: 'https://github.com/thaitype/nammatham', }, ], },