chore: clean up Docusaurus project by removing unused blog files and updating dependencies and configurations

Signed-off-by: Gabryel Nóbrega <[email protected]>

Author: see7e

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changes
+## Removed
+- No need for `docusaurus/blog/` as discussed in Slack, and as the existing text is not relevant to the project, it has been removed.
+- Removed `docusaurus/README.md` as it is already present information duplicated with another files like `docs/howtos/documentation_development.md`.
+- Removed `docusaurus/package-lock.json` as the local development should be done with `yarn`.
+
+## Added
++ Added `docusaurus/docs/howtos/documentation_development.md` as to give instructions on how to develop documentation.
++ Added `docusaurus/docker.package.json` to include the dependencies needed to build the containers.
+
+## Updated
+* Improved `docusaurus/.dockerignore` refenrencing the the other JS modules that are not needed when building the container.
+* Updated `docusaurus/package.json` to include the latest versions of the dependencies.
+* Included at `docusaurus/Dockerfile` the the new instructions to build the containers of Development and Production.

NOTES.md

@@ -0,0 +1,32 @@
+# TODO
+
+- Check if `package-lock.json` is needed in the repository.
+- Confirm repository name for GH Pages deployment:
+    ```js
+    // Set the production url of your site here
+    url: 'https://magma.github.io',
+    // Set the /<baseUrl>/ pathname under which your site is served
+    // For GitHub pages deployment, it is often '/<projectName>/'
+    baseUrl: '/magma/',
+    ```
+- Create social-card.jpg
+
+---
+
+# Translations
+
+Is possible to make two types of translations in Docusaurus:
+
+- Pages: Will not be possible to use React components as the text to be translated will need to be hardcoded in the js file. For that run the following [command](https://docusaurus.io/docs/cli#docusaurus-write-translations-sitedir):
+    ```sh
+    yarn run write-translations -- --locale <locale>
+    ```
+- Markdowns: Run the following command:
+    ```sh
+    mkdir -p i18n/<locale>/docusaurus-plugin-content-docs/current
+    cp -r docs/** i18n/<locale>/docusaurus-plugin-content-docs/current
+    ```
+    This will create a folder with the translated markdowns. The translated markdowns will be in the `i18n` folder.
+    Using this method will be needed to manually update all the markdowns for each language.
+    `TODO` Find a simpler way to translate.
+

docusaurus/.dockerignore

@@ -1 +1,5 @@
+# Local development files
 **/node_modules
+**/package.json
+**/package-lock.json
+**/yarn.lock

docusaurus/.gitignore

@@ -1,20 +1,54 @@
-# Dependencies
-/node_modules
-
-# Production
-/build
-
-# Generated files
-.docusaurus
-.cache-loader
-
-# Misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+# Node modules
+**/data/
+**/node_modules/
+
+# Build files
+**/build/
+**/.docusaurus/
+**/.cache/
+**/.cache-loader/
+
+# Environment variables
+**/.env
+**/.env.local
+**/.env.development.local
+**/.env.test.local
+**/.env.production.local
+
+# Logs
+**/npm-debug.log*
+**/yarn-debug.log*
+**/yarn-error.log*
+**/pnpm-debug.log*
+**/lerna-debug.log*
+
+# IDE-specific files
+**/.idea/
+**/.vscode/
+
+# TypeScript build files
+**/*.tsbuildinfo
+
+# MacOS system files
+**/.DS_Store
+
+# Linux files
+**/*.pid
+
+# Editor-specific files
+**/*.suo
+**/*.ntvs*
+**/*.njsproj
+**/*.sln
+**/*.sw*
+
+# Miscellaneous
+**/*.DS_Store
+**/*.log
+**/*.swp
+
+# Ignore any package-lock or yarn.lock if using a different package manager
+# Uncomment the one you're not using
+**/yarn.lock
+# **/package-lock.json
+# **/pnpm-lock.yaml

docusaurus/Dockerfile

@@ -1,17 +1,38 @@
-# Copyright 2023 The Magma Authors.
+FROM node:20-alpine AS base
 
-# This source code is licensed under the BSD-style license found in the
-# LICENSE file in the root directory of this source tree.
+WORKDIR /
 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+# Copy package.json first
+COPY docker.package.json ./package.json
 
-FROM node:18
+# Check if package-lock.json exists, if not, generate it
+RUN [ -f package-lock.json ] || npm install --package-lock-only
 
-WORKDIR /app/website
+# Copy package-lock.json only if it exists
+COPY package-lock.json* ./
 
-COPY package.json /app/website/package.json
-RUN npm install
+# Install dependencies
+RUN npm ci || npm install
+
+COPY . .
+
+# Development stage
+FROM base AS development
+CMD ["npm", "run", "start"]
+
+# # Production stage
+# FROM base AS build
+# RUN npm run build
+
+# # Use Nginx to serve static files
+# FROM nginx:alpine
+# WORKDIR /usr/share/nginx/html
+
+# # Copy build output from the previous stage
+# COPY --from=build /app/build .
+
+# # Expose port for web server
+# EXPOSE 80
+
+# # Start Nginx
+# CMD ["nginx", "-g", "daemon off;"]