Skip to content

Commit ddb6eea

Browse files
jorgemoralespoujorgemoralespou
authored
Merge pull request #29 from educates/develop
Adding gtag and some minor fixes
2 parents ac7607d + cc6675c commit ddb6eea

File tree

11 files changed

+3223
-4242
lines changed

11 files changed

+3223
-4242
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Code of Conduct
2+
3+
See the Educates Training Platform Code of conduct guide
4+
[here](https://github.com/educates/educates-training-platform/blob/develop/CODE_OF_CONDUCT.md).

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Contributing
2+
3+
See the Educates Training Platform Contributing guide
4+
[here](https://github.com/educates/educates-training-platform/blob/develop/CONTRIBUTING.md).

‎Dockerfile‎

Lines changed: 49 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,52 @@
1-
# Build stage
2-
FROM node:20-slim AS build
3-
4-
WORKDIR /app
5-
6-
# Copy package files
7-
COPY package*.json ./
8-
9-
# Install dependencies
10-
RUN npm install
11-
12-
# Copy source code
13-
COPY . .
14-
15-
# Build the app
16-
RUN npm run build
17-
18-
# Production stage
19-
FROM nginx:alpine
20-
21-
# Copy the built app to nginx html directory
22-
COPY --from=build /app/build /usr/share/nginx/html
23-
24-
# Copy nginx configuration (we'll create this next)
25-
COPY nginx.conf /etc/nginx/conf.d/default.conf
26-
1+
# syntax=docker/dockerfile:1
2+
3+
# TODO: Modify following examples at https://docusaurus.community/knowledge/deployment/docker/?package-managers=yarn
4+
5+
# Stage 1: Base image.
6+
## Start with a base image containing NodeJS so we can build Docusaurus.
7+
FROM node:lts AS base
8+
## Disable colour output from yarn to make logs easier to read.
9+
ENV FORCE_COLOR=0
10+
## Enable corepack.
11+
RUN corepack enable
12+
## Set the working directory to `/opt/docusaurus`.
13+
WORKDIR /opt/docusaurus
14+
15+
16+
# Stage 2a: Development mode.
17+
FROM base AS dev
18+
## Set the working directory to `/opt/docusaurus`.
19+
WORKDIR /opt/docusaurus
20+
## Expose the port that Docusaurus will run on.
21+
EXPOSE 3000
22+
## Run the development server.
23+
CMD [ -d "node_modules" ] && yarn start --host 0.0.0.0 --poll 1000 || yarn install && yarn start --host 0.0.0.0 --poll 1000
24+
25+
# Stage 2b: Production build mode.
26+
FROM base AS prod
27+
## Set the working directory to `/opt/docusaurus`.
28+
WORKDIR /opt/docusaurus
29+
## Copy over the source code.
30+
COPY . /opt/docusaurus/
31+
## Install dependencies with `--immutable` to ensure reproducibility.
32+
RUN yarn install --immutable
33+
## Build the static site.
34+
RUN yarn build
35+
36+
# Stage 3a: Serve with `docusaurus serve`.
37+
FROM prod AS serve
38+
## Expose the port that Docusaurus will run on.
39+
EXPOSE 3000
40+
## Run the production server.
41+
CMD ["yarn", "serve", "--host", "0.0.0.0", "--no-open"]
42+
43+
# Stage 3b: Serve with nginx
44+
FROM nginx:alpine AS nginx
45+
## Copy the nginx configuration.
46+
COPY --from=prod /opt/docusaurus/nginx.conf /etc/nginx/conf.d/default.conf
47+
## Copy the Docusaurus build output.
48+
COPY --from=prod /opt/docusaurus/build /usr/share/nginx/html
2749
# Expose port 80
2850
EXPOSE 80
29-
3051
# Start nginx
31-
CMD ["nginx", "-g", "daemon off;"]
52+
CMD ["nginx", "-g", "daemon off;"]

‎LICENSE‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎README.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,77 @@ $ GIT_USER=<Your GitHub username> yarn deploy
4141
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
4242

4343

44+
## Building the Docker image
45+
46+
To build the docker image you will need to run the following command:
47+
48+
```
49+
docker build --target <target> -t <tag> .
50+
```
51+
52+
To deconstruct the above command:
53+
54+
- docker build - This is the command to build a docker image.
55+
- --target <target> - This is the target to build. The target is the name of the stage in the dockerfile. Valid targets are dev, serve and caddy.
56+
- -t <tag> - This is the name and tag of the image that will be built. The format is <name>:<tag>. The name can be anything you want. The tag is optional. If you do not specify a tag, latest will be used.
57+
- . - This is the path to the build context. In this case we are using the current directory as the build context.
58+
59+
## Running the Docker Image
60+
Depending on stage / target you will need to run the docker image differently.
61+
62+
### Running Dev target
63+
To run the dev target you will need to run the following command:
64+
65+
66+
```
67+
docker run --rm -d -p 3000:3000 -v $(pwd):/opt/docusaurus <tag>
68+
```
69+
70+
If using PowerShell you will need to use ${pwd} instead of $(pwd). On some systems you may need to replace $(pwd) with . or the full path to the directory you want to mount.
71+
72+
To deconstruct the above command:
73+
74+
- docker run - This is the command to run a docker image.
75+
- --rm - This is an optional flag that will remove the container when it exits.
76+
- -d - This is an optional flag that will run the container in detached mode.
77+
- -p 3000:3000 - This is an optional flag that will map port 3000 on the host to port 3000 in the container.
78+
- -v $(pwd):/var/docusaurus - This is an optional flag that will mount the current directory as a volume in the container.
79+
- <tag> - This is the name and tag of the image that will be run. Make sure to use the same tag that you used when building the image.
80+
81+
### Running Serve target
82+
83+
To run the serve target you will need to run the following command:
84+
85+
```
86+
docker run --rm -d -p 3000:3000 <tag>
87+
```
88+
89+
To deconstruct the above command:
90+
91+
- docker run - This is the command to run a docker image.
92+
- --rm - This is an optional flag that will remove the container when it exits.
93+
- -d - This is an optional flag that will run the container in detached mode.
94+
- -p 3000:3000 - This is an optional flag that will map port 3000 on the host to port 3000 in the container.
95+
- <tag> - This is the name and tag of the image that will be run. Make sure to use the same tag that you used when building the image.
96+
97+
### Running Nginx target
98+
99+
To run the nginx target you will need to run the following command:
100+
101+
```
102+
docker run --rm -d -p 8080:80 <tag>
103+
```
104+
105+
If using PowerShell you will need to use ${pwd} instead of $(pwd). On some systems you may need to replace $(pwd) with . or the full path to the directory you want to mount.
106+
107+
To deconstruct the above command:
108+
109+
- docker run - This is the command to run a docker image.
110+
- --rm - This is an optional flag that will remove the container when it exits.
111+
- -d - This is an optional flag that will run the container in detached mode.
112+
- -p 8080:80 - This is an optional flag that will map port 8080 on the host to port 80 in the container.
113+
- <tag> - This is the name and tag of the image that will be run. Make sure to use the same tag that you used when building the image.
114+
44115
## Publishing workflow for GitHub
45116

46117
- Develop your code in branch `develop`

‎blog/tags.yml‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,9 @@ workshops:
7171
hub:
7272
label: Hub
7373
permalink: /hub
74-
description: Hub
74+
description: Hub
75+
76+
terraform:
77+
label: Terraform
78+
permalink: /terraform
79+
description: Terraform

‎docusaurus.config.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,10 @@ const config: Config = {
118118
theme: {
119119
customCss: "./src/css/custom.css",
120120
},
121+
gtag: {
122+
trackingID: "G-6E8JHKBWNX",
123+
anonymizeIP: true,
124+
},
121125
} satisfies Preset.Options,
122126
],
123127
],

0 commit comments

Comments
 (0)