From ccf2c3d4464c188a07f88b07cc71671e1cfad842 Mon Sep 17 00:00:00 2001 From: devilkiller-ag Date: Mon, 6 May 2024 19:02:23 +0530 Subject: [PATCH 1/8] update readme --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 37f8ff838522..e575d2c63862 100644 --- a/README.md +++ b/README.md @@ -33,8 +33,8 @@ This repository contains the sources of AsyncAPI website: Use the following tools to set up the project: -- [Node.js](https://nodejs.org/) v16.0.0+ -- [npm](https://www.npmjs.com/) v8.10.0+ +- [Node.js](https://nodejs.org/) v20.12.0+ +- [npm](https://www.npmjs.com/) v10.5.0+ ## Run locally @@ -117,6 +117,24 @@ After cloning repository to your local, perform the following steps from the roo Now you're running AsyncAPI website in a development mode. Container is mapped with your local copy of the website. Whenever you make changes to the code, the website will refresh and changes visible in localhost:3000. +## Lint the code +To lint the code, run the following command: +``` +npm run lint +``` + +To fix the linting issues, run the following command: +``` +npm run lint:fix +``` + +## Start the production server +To build and run a production-ready website, run the following command: +``` +npm run build && npm run start +``` +Generated files of the website go to the `.next` folder. + ## Updating information about project finance AsyncAPI Financial Summary page aims to provide transparency and clarity regarding the organization's financial activities. It serves as a platform to showcase how donations are accepted, different sponsorship options, and how the generated funds are utilized. From e04ca77f1bc6877b139c2366602e52a21075e2c6 Mon Sep 17 00:00:00 2001 From: devilkiller-ag Date: Sun, 12 May 2024 10:03:32 +0530 Subject: [PATCH 2/8] added instructions for running netlify production server --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index e575d2c63862..e97acc9e0b5b 100644 --- a/README.md +++ b/README.md @@ -135,6 +135,16 @@ npm run build && npm run start ``` Generated files of the website go to the `.next` folder. +## Start the netlify production server +To start a local development server for the build tool using the configuration and environment variables set for local development with the Netlify CLI, run the following command: +``` +netlify dev +``` +To start the server using the configuration and environment variables set for `dev` or `all` deploy contexts, run the following command: +``` +netlify dev --context production +``` + ## Updating information about project finance AsyncAPI Financial Summary page aims to provide transparency and clarity regarding the organization's financial activities. It serves as a platform to showcase how donations are accepted, different sponsorship options, and how the generated funds are utilized. From 52218f6934997ae81e994d505bbe859155667606 Mon Sep 17 00:00:00 2001 From: devilkiller-ag Date: Thu, 16 May 2024 19:22:42 +0530 Subject: [PATCH 3/8] added mdx linting instructions --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index e97acc9e0b5b..d0c01452f9d8 100644 --- a/README.md +++ b/README.md @@ -128,6 +128,11 @@ To fix the linting issues, run the following command: npm run lint:fix ``` +To lint the mdx files, run the following command: +``` +npm run lint:mdx +``` + ## Start the production server To build and run a production-ready website, run the following command: ``` From 81dee888a3296c22eaf86ac3377af0b07527d6ea Mon Sep 17 00:00:00 2001 From: devilkiller-ag Date: Fri, 17 May 2024 18:47:53 +0530 Subject: [PATCH 4/8] updated repo structure in readme --- README.md | 67 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 49 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index d0c01452f9d8..13532fd866fb 100644 --- a/README.md +++ b/README.md @@ -229,24 +229,55 @@ This repository has the following structure: ```text - ├── .github # Definitions of GitHub workflows, pull request and issue templates - ├── components # Various generic components such as "Button", "Figure", etc. - ├── config # Transformed static data to display on the pages such as blog posts etc. - ├── context # Various React's contexts used in website - ├── css # Various CSS files - ├── lib # Various JS code for preparing static data to render in pages - ├── pages # Website's pages source. It includes raw markdown files and React page templates. - │ ├── about # Raw blog for /about page - │ ├── blog # Blog posts - │ ├── docs # Blog for /docs/* pages - │ └── tools # Various pages to describe tools - ├── public # Data for site metadata and static blog such as images - ├── scripts # Scripts used in the build and dev processes - ├── next.config.js # Next.js configuration file - ├── netlify # Code that runs on Netlify - │ ├── edge-functions # Netlify Edge-Functions code - ├── postcss.config.js # PostCSS configuration file - └── tailwind.config.js # TailwindCSS configuration file + ├── .github # Definitions of GitHub workflows, pull request and issue templates + ├── assets # Various assets + | ├── docs # Documentation assets + | | fragments # Docuentation for CLI installation and contribution. + ├── components # Various generic components such as "Button", "Figure", etc. + ├── config # Transformed static data to display on the pages such as blog posts etc. + ├── context # Various React's contexts used in website + ├── locales # Translations for the website + ├── markdown # Markdown files for the website + ├── about # Markdown files for the /about page + ├── blog # Markdown files for the blog posts + ├── docs # Markdown files for the /docs/* pages + ├── netlify # Code that runs on Netlify + ├── pages # Website's pages source. It includes raw markdown files and React page templates. + │ ├── about # Raw blog for /about page + │ ├── blog # Blog posts + │ ├── docs # Blog for /docs/* pages + │ └── tools # Various pages to describe tools + ├── public # Data for site metadata and static blog such as images + ├── scripts # Scripts used in the build and dev processes + ├── styles # Various CSS files + ├── templates # Various template markdown files + ├── types # Various typeScript types used in the website + ├── utils # Various JS code for preparing static data to render in pages + ├── .all-contributorsrc # File having details of all contributors + ├── .dockerignore # Docker ignore file + ├── .editorconfig # Editor configuration file + ├── .eslintrc # ESLint configuration file + ├── .gitignore # Git ignore file + ├── .gitpod.yml # Gitpod configuration file + ├── .remarkrc # Configuration file for remark + ├── ADDING_TRANSLATIONS.md # Guide on how to add translations + ├── CODE_OF_CONDUCT.md # Code of conduct + ├── Contributing.md # Contributing guidelines + ├── dashboard.json # Data for dashboard page + ├── Dockerfile # Dockerfile for building the website + ├── LICENSE # License file + ├── mlc_config.json # Configuration file for markdown-link-checker + ├── netlify.toml # Netlify configuration file + ├── next-env.d.ts # Next.js environment types + ├── next-i18next-static-site.config.js # Next.js i18next configuration file + ├── next.config.mjs # Next.js configuration file + ├── package-lock.json # NPM package lock file + ├── package.json # NPM package configuration file + ├── postcss.config.js # PostCSS configuration file + ├── README.md # Project's README file + ├── roadmap.json # Data for roadmap page + ├── tailwind.config.js # TailwindCSS configuration file + └── tsconfig.json # TypeScript configuration file ``` ## Connect with AsyncAPI Community From d352e537e6ca52b6ca2f49f5f05004b97eb9db31 Mon Sep 17 00:00:00 2001 From: devilkiller-ag Date: Fri, 17 May 2024 18:48:45 +0530 Subject: [PATCH 5/8] updated repo structure in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 13532fd866fb..4dcb89172199 100644 --- a/README.md +++ b/README.md @@ -232,7 +232,7 @@ This repository has the following structure: ├── .github # Definitions of GitHub workflows, pull request and issue templates ├── assets # Various assets | ├── docs # Documentation assets - | | fragments # Docuentation for CLI installation and contribution. + | | fragments # Docuentations for CLI installation and contribution. ├── components # Various generic components such as "Button", "Figure", etc. ├── config # Transformed static data to display on the pages such as blog posts etc. ├── context # Various React's contexts used in website From 1fa488ec1bf3a55959208747ff794c890ce1cbf6 Mon Sep 17 00:00:00 2001 From: Quetzalli Date: Fri, 17 May 2024 21:27:20 -0700 Subject: [PATCH 6/8] grammar fixes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4dcb89172199..8ee176ca79d7 100644 --- a/README.md +++ b/README.md @@ -138,10 +138,10 @@ To build and run a production-ready website, run the following command: ``` npm run build && npm run start ``` -Generated files of the website go to the `.next` folder. +Generated files of the website go in the `.next` folder. ## Start the netlify production server -To start a local development server for the build tool using the configuration and environment variables set for local development with the Netlify CLI, run the following command: +Start a local development server for the build tool using the configuration and environment variables set for local development with the Netlify CLI: ``` netlify dev ``` From bc54825feec36f17fc30c02d3dc7ff050cd28365 Mon Sep 17 00:00:00 2001 From: devilkiller-ag Date: Sat, 18 May 2024 10:33:25 +0530 Subject: [PATCH 7/8] removed unneccesary file descriptions --- README.md | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/README.md b/README.md index 8ee176ca79d7..674e1f969f64 100644 --- a/README.md +++ b/README.md @@ -253,29 +253,8 @@ This repository has the following structure: ├── templates # Various template markdown files ├── types # Various typeScript types used in the website ├── utils # Various JS code for preparing static data to render in pages - ├── .all-contributorsrc # File having details of all contributors - ├── .dockerignore # Docker ignore file - ├── .editorconfig # Editor configuration file - ├── .eslintrc # ESLint configuration file - ├── .gitignore # Git ignore file - ├── .gitpod.yml # Gitpod configuration file - ├── .remarkrc # Configuration file for remark - ├── ADDING_TRANSLATIONS.md # Guide on how to add translations - ├── CODE_OF_CONDUCT.md # Code of conduct - ├── Contributing.md # Contributing guidelines - ├── dashboard.json # Data for dashboard page - ├── Dockerfile # Dockerfile for building the website - ├── LICENSE # License file - ├── mlc_config.json # Configuration file for markdown-link-checker - ├── netlify.toml # Netlify configuration file - ├── next-env.d.ts # Next.js environment types - ├── next-i18next-static-site.config.js # Next.js i18next configuration file ├── next.config.mjs # Next.js configuration file - ├── package-lock.json # NPM package lock file - ├── package.json # NPM package configuration file - ├── postcss.config.js # PostCSS configuration file ├── README.md # Project's README file - ├── roadmap.json # Data for roadmap page ├── tailwind.config.js # TailwindCSS configuration file └── tsconfig.json # TypeScript configuration file ``` From 80c1a6e9181e0a8921412aa02722c774e52452af Mon Sep 17 00:00:00 2001 From: Akshat Nema <76521428+akshatnema@users.noreply.github.com> Date: Sat, 18 May 2024 12:49:53 +0530 Subject: [PATCH 8/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 674e1f969f64..f394899ca9a3 100644 --- a/README.md +++ b/README.md @@ -241,7 +241,7 @@ This repository has the following structure: ├── about # Markdown files for the /about page ├── blog # Markdown files for the blog posts ├── docs # Markdown files for the /docs/* pages - ├── netlify # Code that runs on Netlify + ├── netlify # Contains Netlify serverless functions to run on Netlify ├── pages # Website's pages source. It includes raw markdown files and React page templates. │ ├── about # Raw blog for /about page │ ├── blog # Blog posts