Fixes #2792 Set up Docusaurus as a Microservice

[cindyorangis]

Issue This PR Addresses

Fixes #2792
Fixes #2746
Fixes #290

Type of Change

• Bugfix: Change which fixes an issue
• New Feature: Change which adds functionality
• Documentation Update: Change which improves documentation
• UI: Change which improves UI

Description

This sets up Docusaurus in a Docker container that runs locally on port 4631.

So far, I only have the Docusaurus website running in a Docker container. To test the container:

1. Add my repository as a remote: git remote add cindyledev https://github.com/cindyledev/telescope.git
2. Fetch my branches: git fetch cindyledev
3. Checkout my branch: git checkout docusaurus
4. Change directory to /src/docs: cd src/docs
5. Build the Docker image: docker build --target development -t docs:dev .
6. Run the Docker container: docker run -p 4631:4631 docs:dev
7. Go to localhost:4631 to see the Docusaurus website.

TODO
Nginx stuff

---

How to test this PR

1. Add my repository as a remote: git remote add cindyledev https://github.com/cindyledev/telescope.git
2. Fetch my branches: git fetch cindyledev
3. Checkout my branch: git checkout docusaurus
4. Install dependencies: pnpm install
5. Start the Docker containers: pnpm services:start

Go to localhost:4631 to see the Docusaurus website.

Steps to test the PR

Checklist

• Quality: This PR builds and passes our npm test and works locally
• Tests: This PR includes thorough tests or an explanation of why it does not
• Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not (if applicable)
• Documentation: This PR includes updated/added documentation to user exposed functionality or configuration variables are added/changed or an explanation of why it does not(if applicable)

[gitpod-io]

[humphd]

These eslint errors will require you to add a new section to our .eslintrc.js file in the root under the overrides section that defines what to do for src/api/docs/**/*.js. Use the src/web or src/api/status as an example.

[humphd]

Let's also change the routing to /docs, so you'd go to telescope.cdot.systems/docs to see all this.

This is exciting to see happening.

[aserputov]

@cindyledev can I help you somehow ?

[manekenpix]

Should we add src/docs to pnpm-workspaces.yaml?

[manekenpix]

Accessing it via traefik shows 404. With a bit of tweaking, I managed to access it using localhost/docs (behind traefik), but all I could get was

Changing baseUrl breaks the build. Since this is not an API, would it make sense to run it just behind nginx and not behind nginx and traefik? I think nginx could just serve the docs as static content. as we do with our front-end (and we wouldn't have to use docusaurus's server).

[humphd]

If we do this with nginx, we can drop all this, and have docs depend only on nginx.

[JerryHue]

I'm having problems building the docker container through pnpm run services:start.

I am not very familiar with docker, but I think these are the problematic parts. The deploy image we are using uses debian instead of alpine, which makes the line RUN apk ... to fail: apk does not exist. I tried to change it to apt-get install tini, but the package cannot be found (despite the tini GitHub repo saying otherwise...).

Maybe we could use an alpine image when building everything, and then place the nginx image right before the COPYing step, just like we do in src/web/Dockerfile?

[humphd]

We don't need tini at all, we can get rid of this completely, since we aren't actually running a process. tini is for running the node process in a container. In this case, we build the site with node, then copy the results into the nginx container's filesystem where it expects to find it.

We could change nginx:stable to nginx:stable-alpine though, to save some size.

[cindyorangis]

Thank you for the reviews. I'm not a Docker pro so I copied and pasted some of @humphd work from #2808 . Also removed tini and changed nginx:stable to nginx:stable-alpine

[Kevan-Y]

Wasn't able to run got this issue,

I asked for some help @humphd answered with

COPY --from=deploy /home/node/app/build /var/www/data
that is trying to copy something from the deploy stage into the deploy stage
get rid of --from=deploy
get rid of RUN apk --no-cache add tini too (edited) 
this needs to be reworked

But wasn't able to run it probably need a bit of rework

Did Dave review this in the Docker/Nginx meeting on Feb 4th? I'm so sad I missed it and I'm even more sad that no one recorded it! :(

I copied and pasted some stuff from our /src/web/Dockerfile hence the
COPY --from=deploy /home/node/app/build /var/www/data cough cough. You think I'd know what I'm copying but not all the time... I updated it to

# Copy build output to /var/www/data to be served
COPY /home/node/app/build /var/www/data

[cindyorangis]

Steps to test the Docusarus website Docker container

1. Add my repository as a remote: git remote add cindyledev https://github.com/cindyledev/telescope.git
2. Fetch my branches: git fetch cindyledev
3. Checkout my branch: git checkout docusaurus
4. Change directory to /src/docs: cd src/docs
5. Build the Docker image: docker build --target development -t docs:dev .
6. Run the Docker container: docker run -p 4631:4631 docs:dev
7. Go to localhost:4631 to see the Docusaurus website.

[cindyorangis]

Wow apparently my PR is so bad that CI checks don't even wanna run tests for it =_=

[humphd]

@cindyledev this PR is pretty big, and I'm not 100% if you're ready for review? Let me know what help you need/want and when.

[JerryHue]

I wonder if we can break down the PR so that it is easier for reviewing?

In the issue #2792, I was expecting just Docusaurus to be installed in the project, and then later address the dockerization in a future issue/PR.

If that's not an option, then @cindyledev, would you accept if we make a PR on your branch? That way, we won't have to throw away the work you did.

[cindyorangis]

I wonder if we can break down the PR so that it is easier for reviewing?

In the issue #2792, I was expecting just Docusaurus to be installed in the project, and then later address the dockerization in a future issue/PR.

If that's not an option, then @cindyledev, would you accept if we make a PR on your branch? That way, we won't have to throw away the work you did.

I will slim down this PR tomorrow because you're right, this PR is supposed to "Set up Docusaurus", I went too far out of scope which made it extremely difficult to review.

[cindyorangis]

Thank you everyone for your feedback here. Closing this one in favour of #2853. Follow up issues will be filed later