From 44547a13aadecdd1f7193f70c81832cb4c34190c Mon Sep 17 00:00:00 2001 From: BorjaZarco Date: Mon, 24 Jul 2023 10:52:08 +0100 Subject: [PATCH 1/7] ignore static files --- website/.gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/website/.gitignore b/website/.gitignore index b2d6de3..1849170 100644 --- a/website/.gitignore +++ b/website/.gitignore @@ -8,6 +8,9 @@ .docusaurus .cache-loader +# Static files to be ignored +/static/gitignore + # Misc .DS_Store .env.local From c364ad58e01a8f749a6ce73a674cde851cb9be2a Mon Sep 17 00:00:00 2001 From: BorjaZarco Date: Mon, 24 Jul 2023 10:52:19 +0100 Subject: [PATCH 2/7] copy community files from root --- website/package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/website/package.json b/website/package.json index d468923..f19b50c 100644 --- a/website/package.json +++ b/website/package.json @@ -5,6 +5,7 @@ "scripts": { "docusaurus": "docusaurus", "start": "docusaurus start", + "prebuild": "cp ../CODE_OF_CONDUCT.md ./static/gitignore && cp ../CONTRIBUTING.md ./static/gitignore", "build": "docusaurus build", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", From 5a3ad3c5b6237fb66da02de16617421363f3b9f8 Mon Sep 17 00:00:00 2001 From: BorjaZarco Date: Mon, 24 Jul 2023 10:52:35 +0100 Subject: [PATCH 3/7] change imports (now from static folder) --- website/docs/04_community/code_of_conduct.mdx | 2 +- website/docs/04_community/contributing.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/04_community/code_of_conduct.mdx b/website/docs/04_community/code_of_conduct.mdx index 307c1c7..689cf73 100644 --- a/website/docs/04_community/code_of_conduct.mdx +++ b/website/docs/04_community/code_of_conduct.mdx @@ -1,4 +1,4 @@ -import CodeOfConduct from '../../../CODE_OF_CONDUCT.md'; +import CodeOfConduct from '@site/static/CODE_OF_CONDUCT.md'; # Contributor Covenant Code of Conduct diff --git a/website/docs/04_community/contributing.mdx b/website/docs/04_community/contributing.mdx index 24612a9..336530b 100644 --- a/website/docs/04_community/contributing.mdx +++ b/website/docs/04_community/contributing.mdx @@ -1,4 +1,4 @@ -import ContributingGuide from '../../../CONTRIBUTING.md'; +import ContributingGuide from '@site/static/CONTRIBUTING.md'; # Contributing Guide From 0397ab56a4790fc349500e7bf1518dfe75046d53 Mon Sep 17 00:00:00 2001 From: BorjaZarco Date: Mon, 24 Jul 2023 10:55:59 +0100 Subject: [PATCH 4/7] add docusaurus check action --- .github/workflows/docusaurus-check.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/docusaurus-check.yml diff --git a/.github/workflows/docusaurus-check.yml b/.github/workflows/docusaurus-check.yml new file mode 100644 index 0000000..a9eb0b9 --- /dev/null +++ b/.github/workflows/docusaurus-check.yml @@ -0,0 +1,26 @@ +name: Docusaurus build + +on: + pull_request: + branches: [main] + paths: + - 'website/**' + +jobs: + build: + runs-on: ubuntu-latest + + defaults: + run: + working-directory: ./website + + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 18 + + - name: Install dependencies + run: npm ci + - name: Build website + run: npm run build From d7ac679397359ffdb6c2c27af1b6290f36ed8c0d Mon Sep 17 00:00:00 2001 From: BorjaZarco Date: Mon, 24 Jul 2023 11:50:14 +0100 Subject: [PATCH 5/7] fix import --- website/docs/04_community/code_of_conduct.mdx | 2 +- website/docs/04_community/contributing.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/04_community/code_of_conduct.mdx b/website/docs/04_community/code_of_conduct.mdx index 689cf73..f22c904 100644 --- a/website/docs/04_community/code_of_conduct.mdx +++ b/website/docs/04_community/code_of_conduct.mdx @@ -1,4 +1,4 @@ -import CodeOfConduct from '@site/static/CODE_OF_CONDUCT.md'; +import CodeOfConduct from '@site/static/gitignore/CODE_OF_CONDUCT.md'; # Contributor Covenant Code of Conduct diff --git a/website/docs/04_community/contributing.mdx b/website/docs/04_community/contributing.mdx index 336530b..e4ad8d2 100644 --- a/website/docs/04_community/contributing.mdx +++ b/website/docs/04_community/contributing.mdx @@ -1,4 +1,4 @@ -import ContributingGuide from '@site/static/CONTRIBUTING.md'; +import ContributingGuide from '@site/static/gitignore/CONTRIBUTING.md'; # Contributing Guide From 63dbc5d8b3b5b1ece7afc8864834c063e94ebb25 Mon Sep 17 00:00:00 2001 From: BorjaZarco Date: Mon, 24 Jul 2023 12:25:18 +0100 Subject: [PATCH 6/7] rollback fix --- website/.gitignore | 3 --- website/package.json | 1 - 2 files changed, 4 deletions(-) diff --git a/website/.gitignore b/website/.gitignore index 1849170..b2d6de3 100644 --- a/website/.gitignore +++ b/website/.gitignore @@ -8,9 +8,6 @@ .docusaurus .cache-loader -# Static files to be ignored -/static/gitignore - # Misc .DS_Store .env.local diff --git a/website/package.json b/website/package.json index f19b50c..d468923 100644 --- a/website/package.json +++ b/website/package.json @@ -5,7 +5,6 @@ "scripts": { "docusaurus": "docusaurus", "start": "docusaurus start", - "prebuild": "cp ../CODE_OF_CONDUCT.md ./static/gitignore && cp ../CONTRIBUTING.md ./static/gitignore", "build": "docusaurus build", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy", From aaae996b07a35f292dc4c2c37b66dd6e6ce7b2fd Mon Sep 17 00:00:00 2001 From: BorjaZarco Date: Mon, 24 Jul 2023 12:25:36 +0100 Subject: [PATCH 7/7] have a single community doc that redirects to markdown files --- .../{04_community/index.md => 04_community.md} | 2 +- website/docs/04_community/code_of_conduct.mdx | 7 ------- website/docs/04_community/contributing.mdx | 7 ------- website/sidebars.js | 17 +---------------- 4 files changed, 2 insertions(+), 31 deletions(-) rename website/docs/{04_community/index.md => 04_community.md} (73%) delete mode 100644 website/docs/04_community/code_of_conduct.mdx delete mode 100644 website/docs/04_community/contributing.mdx diff --git a/website/docs/04_community/index.md b/website/docs/04_community.md similarity index 73% rename from website/docs/04_community/index.md rename to website/docs/04_community.md index 42b2263..20f99cf 100644 --- a/website/docs/04_community/index.md +++ b/website/docs/04_community.md @@ -7,4 +7,4 @@ Community contributions are essential to the development and refinement of eLLMe 3. Look at the [Open Issues](https://github.com/theam/ellmental/issues), choose one that interests you, and start contributing. 4. Spread the word about eLLMental! -Find detailed instructions and guidelines in the [Contributing Guide](contributing), and make sure to read our [Code of Conduct](code_of_conduct) before you start contributing. +Find detailed instructions and guidelines in the [Contributing Guide](https://github.com/theam/ellmental.py/blob/main/CONTRIBUTING.md), and make sure to read our [Code of Conduct](https://github.com/theam/ellmental.py/blob/main/CODE_OF_CONDUCT.md) before you start contributing. diff --git a/website/docs/04_community/code_of_conduct.mdx b/website/docs/04_community/code_of_conduct.mdx deleted file mode 100644 index f22c904..0000000 --- a/website/docs/04_community/code_of_conduct.mdx +++ /dev/null @@ -1,7 +0,0 @@ -import CodeOfConduct from '@site/static/gitignore/CODE_OF_CONDUCT.md'; - -# Contributor Covenant Code of Conduct - -
- -
\ No newline at end of file diff --git a/website/docs/04_community/contributing.mdx b/website/docs/04_community/contributing.mdx deleted file mode 100644 index e4ad8d2..0000000 --- a/website/docs/04_community/contributing.mdx +++ /dev/null @@ -1,7 +0,0 @@ -import ContributingGuide from '@site/static/gitignore/CONTRIBUTING.md'; - -# Contributing Guide - -
- -
\ No newline at end of file diff --git a/website/sidebars.js b/website/sidebars.js index 96f1e95..9f4eb8a 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -31,22 +31,7 @@ const sidebars = { 'semantic_search/embedding_stores', ], }, - { - type: 'category', - label: 'Community', - link: { - type: 'doc', - id: 'community/index', - }, - items: [ - 'community/contributing', - { - type: 'doc', - id: 'community/code_of_conduct', - label: 'Code of Conduct', - }, - ], - }, + 'community', ], };