From b5df4020ec987b6456e6e6bc369d37091717e8b1 Mon Sep 17 00:00:00 2001 From: Ege Korkan Date: Fri, 11 Jul 2025 00:15:21 +0300 Subject: [PATCH 01/10] add dependencies and config files --- .prettierignore | 5 +++++ .prettierrc.json | 7 +++++++ package-lock.json | 19 ++++++++++++++++++- package.json | 6 ++++-- 4 files changed, 34 insertions(+), 3 deletions(-) create mode 100644 .prettierignore create mode 100644 .prettierrc.json diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..df955a1 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,5 @@ +package-lock.json +.docusaurus +node_modules +build +.nyc_output \ No newline at end of file diff --git a/.prettierrc.json b/.prettierrc.json new file mode 100644 index 0000000..1d4ebc0 --- /dev/null +++ b/.prettierrc.json @@ -0,0 +1,7 @@ +{ + "trailingComma": "es5", + "printWidth": 120, + "singleQuote": false, + "tabWidth": 4, + "endOfLine": "lf" +} \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 0ab7549..3b91b17 100644 --- a/package-lock.json +++ b/package-lock.json @@ -30,7 +30,8 @@ }, "devDependencies": { "@docusaurus/module-type-aliases": "^3.5.2", - "@docusaurus/types": "^3.5.2" + "@docusaurus/types": "^3.5.2", + "prettier": "^3.6.2" }, "engines": { "node": ">=18.0" @@ -12366,6 +12367,22 @@ "postcss": "^8.4.31" } }, + "node_modules/prettier": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.6.2.tgz", + "integrity": "sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ==", + "dev": true, + "license": "MIT", + "bin": { + "prettier": "bin/prettier.cjs" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" + } + }, "node_modules/pretty-error": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/pretty-error/-/pretty-error-4.0.0.tgz", diff --git a/package.json b/package.json index f25d2e4..fcb37af 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,8 @@ "clear": "docusaurus clear", "serve": "docusaurus serve", "write-translations": "docusaurus write-translations", - "write-heading-ids": "docusaurus write-heading-ids" + "write-heading-ids": "docusaurus write-heading-ids", + "format": "prettier --write ." }, "dependencies": { "@docusaurus/core": "^3.5.2", @@ -36,7 +37,8 @@ }, "devDependencies": { "@docusaurus/module-type-aliases": "^3.5.2", - "@docusaurus/types": "^3.5.2" + "@docusaurus/types": "^3.5.2", + "prettier": "^3.6.2" }, "browserslist": { "production": [ From cc179c193702eabdd5293c0b8649ef2647064694 Mon Sep 17 00:00:00 2001 From: Ege Korkan Date: Fri, 11 Jul 2025 00:17:45 +0300 Subject: [PATCH 02/10] run format --- .github/workflows/static.yml | 58 +- .prettierrc.json | 2 +- CODE_OF_CONDUCT.md | 20 +- CONTRIBUTING.md | 94 +- NOTICE.md | 2 +- README.md | 1 + SECURITY.md | 3 +- babel.config.js | 4 +- docs/introduction.md | 3 +- docusaurus.config.js | 609 ++++++------ get-involved/introduction.md | 1 + hands-on/articles/_category_.json | 2 +- hands-on/articles/exposed-thing.md | 175 ++-- hands-on/articles/intro-raspberry.md | 43 +- hands-on/articles/smart-coffee-machine.md | 34 +- package.json | 112 +-- services/introduction.md | 9 +- sidebars-get-involved.js | 8 +- sidebars-hands-on.js | 8 +- sidebars-services.js | 8 +- sidebars.js | 19 +- src/components/ClientOnlyWorkflow/index.js | 135 ++- .../ClientOnlyWorkflow/styles.module.scss | 13 +- src/components/CommunitySection/index.js | 240 ++--- .../CommunitySection/styles.module.scss | 11 +- src/components/FeedbackPrompt/index.js | 16 +- .../FeedbackPrompt/styles.module.scss | 62 +- src/components/HomepageHeader/index.js | 207 ++-- .../HomepageHeader/styles.module.scss | 14 +- src/components/PlatformWorkflow/index.js | 370 ++++++-- .../PlatformWorkflow/styles.module.scss | 23 +- src/components/SDKWorkflow/index.js | 269 +++++- src/components/SDKWorkflow/styles.module.scss | 23 +- src/components/ServicesSection/index.js | 255 ++--- .../ServicesSection/styles.module.scss | 179 ++-- src/components/ToolsSection/GitHubButton.js | 78 +- src/components/ToolsSection/ToolCard.js | 66 +- src/components/ToolsSection/index.js | 157 ++-- .../ToolsSection/styles.module.scss | 13 +- src/components/VpSection/index.js | 162 +++- src/components/VpSection/styles.module.scss | 51 +- src/components/WorkflowsSection/index.js | 167 ++-- .../WorkflowsSection/styles.module.scss | 21 +- src/css/custom.scss | 881 +++++++++--------- src/pages/index.js | 48 +- static/js/consentBanner.js | 107 ++- 46 files changed, 2792 insertions(+), 1991 deletions(-) diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml index b9c9160..3953bba 100644 --- a/.github/workflows/static.yml +++ b/.github/workflows/static.yml @@ -2,42 +2,42 @@ name: Deploy static content to Pages on: - # Runs on pushes targeting the default branch - push: - branches: ["gh-pages"] + # Runs on pushes targeting the default branch + push: + branches: ["gh-pages"] - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages permissions: - contents: read - pages: write - id-token: write + contents: read + pages: write + id-token: write # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. concurrency: - group: "pages" - cancel-in-progress: false + group: "pages" + cancel-in-progress: false jobs: - # Single deploy job since we're just deploying - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Setup Pages - uses: actions/configure-pages@v5 - - name: Upload artifact - uses: actions/upload-pages-artifact@v3 - with: - # Upload entire repository - path: '.' - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: "." + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.prettierrc.json b/.prettierrc.json index 1d4ebc0..8c70045 100644 --- a/.prettierrc.json +++ b/.prettierrc.json @@ -4,4 +4,4 @@ "singleQuote": false, "tabWidth": 4, "endOfLine": "lf" -} \ No newline at end of file +} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index c2135ea..ae3201d 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -11,19 +11,19 @@ In the interest of fostering an open and welcoming environment, we as community Examples of behavior that contributes to creating a positive environment include: -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community -- Showing empathy towards other community members +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members Examples of unacceptable behavior by participants include: -- The use of sexualized language or imagery and unwelcome sexual attention or advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or electronic address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a professional setting +- The use of sexualized language or imagery and unwelcome sexual attention or advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8bccc73..076105c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thanks for your interest in this project. General information regarding source code management, builds, coding standards, and more can be found here: -* https://projects.eclipse.org/projects/iot.thingweb/developer +- https://projects.eclipse.org/projects/iot.thingweb/developer ## Legal Requirements @@ -13,22 +13,22 @@ This process helps us in creating great open source software within a safe legal Thus, before your contribution can be accepted by the project team, contributors must electronically sign the [Eclipse Contributor Agreement (ECA)](http://www.eclipse.org/legal/ECA.php) and follow these preliminary steps: -* Obtain an [Eclipse Foundation account](https://accounts.eclipse.org/) - * Anyone who currently uses Eclipse Bugzilla or Gerrit systems already has one of those - * Newcomers can [create a new account](https://accounts.eclipse.org/user/register?destination=user) -* Add your GiHub username to your Eclipse Foundation account - * ([Log into Eclipse](https://accounts.eclipse.org/)) - * Go to the *Edit Profile* tab - * Fill in the *GitHub ID* under *Social Media Links* and save -* Sign the [Eclipse Contributor Agreement](http://www.eclipse.org/legal/ECA.php) - * ([Log into Eclipse](https://accounts.eclipse.org/)) - * If the *Status* entry *Eclipse Contributor Agreement* has a green checkmark, the ECA is already signed - * If not, go to the *Eclipse Contributor Agreement* tab or follow the corresponding link under *Status* - * Fill out the form and sign it electronically -* Sign-off every commit using the same email address used for your Eclipse account - * Set the Git user email address with `git config user.email ""` - * Add the `-s` flag when you make the commit(s), e.g. `git commit -s -m "feat: add support for magic"` -* Open a [Pull Request](https://github.com/eclipse-thingweb/node-wot/pulls) +- Obtain an [Eclipse Foundation account](https://accounts.eclipse.org/) + - Anyone who currently uses Eclipse Bugzilla or Gerrit systems already has one of those + - Newcomers can [create a new account](https://accounts.eclipse.org/user/register?destination=user) +- Add your GiHub username to your Eclipse Foundation account + - ([Log into Eclipse](https://accounts.eclipse.org/)) + - Go to the _Edit Profile_ tab + - Fill in the _GitHub ID_ under _Social Media Links_ and save +- Sign the [Eclipse Contributor Agreement](http://www.eclipse.org/legal/ECA.php) + - ([Log into Eclipse](https://accounts.eclipse.org/)) + - If the _Status_ entry _Eclipse Contributor Agreement_ has a green checkmark, the ECA is already signed + - If not, go to the _Eclipse Contributor Agreement_ tab or follow the corresponding link under _Status_ + - Fill out the form and sign it electronically +- Sign-off every commit using the same email address used for your Eclipse account + - Set the Git user email address with `git config user.email ""` + - Add the `-s` flag when you make the commit(s), e.g. `git commit -s -m "feat: add support for magic"` +- Open a [Pull Request](https://github.com/eclipse-thingweb/node-wot/pulls) For more information, please see the Eclipse Committer Handbook: https://www.eclipse.org/projects/handbook/#resources-commit @@ -37,6 +37,7 @@ https://www.eclipse.org/projects/handbook/#resources-commit Eclipse Thingweb uses Conventional Changelog, which structure Git commit messages in a way that allows automatic generation of changelogs. Commit messages must be structured as follows: + ``` (): @@ -45,38 +46,41 @@ Commit messages must be structured as follows: