Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Serve docusaurus docs from a docker container for quick docs verification #1720

Closed
marcellodesales opened this issue Jan 3, 2025 · 3 comments
Labels
enhancement New feature or request

Comments

@marcellodesales
Copy link
Contributor

marcellodesales commented Jan 3, 2025

Is your feature request related to a problem? Please describe.

The docs are failing to build because of a typescript error

Describe the solution you'd like

I'd like to have the docs dir dockerize for quick linting of the docs, validation and quick check.

Describe alternatives you've considered

I prefer to have isolated builds for everything to make sure we have all in CI properly

Additional context

Error while verifying the docs, spending more than an hour to verify that a lot of the dependencies of docs/package.json were missing.

I isolated the docs linter problem to the following file: docs/packages/plugins.md

NOTE: I built a docker image to isolate the problem in a reproducible way.

    39.56 [webpackbar] ✔ Client: Compiled with some errors in 37.40s
    39.56 [ERROR] Client bundle compiled with errors therefore further build is impossible.
    39.56 Error: MDX compilation failed for file "/opt/docusaurus/docs/packages/plugins.md"
    39.56 Cause: Unexpected lazy line in expression in container, expected line to be prefixed with `>` when in a block quote, whitespace when in a list, etc
    39.56 Details:
    39.56 {
    39.56   "column": 1,
    39.56   "message": "Unexpected lazy line in expression in container, expected line to be prefixed with `>` when in a block quote, whitespace when in a list, etc",
    39.56   "line": 617,
    39.56   "name": "617:1",
@marcellodesales marcellodesales added the enhancement New feature or request label Jan 3, 2025
@marcellodesales marcellodesales changed the title Serve docs from a docker container for quick docs verification Serve docusaurus docs from a docker container for quick docs verification Jan 3, 2025
@marcellodesales
Copy link
Contributor Author

I have added PR #1722 to solve the bug and add support for building the docusaurus locally in a docker container:

  • Quick lint of the typescript docs
  • Local validation of the server by running it from docker compose.

@madjin
Copy link
Collaborator

madjin commented Jan 4, 2025

merged, closing issue

@madjin madjin closed this as completed Jan 4, 2025
@marcellodesales
Copy link
Contributor Author

@madjin I think I broke the build... I see the develop CI running... I did change a package.json requirement for the documents...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants