feat(scripts): update Makefile commands and script folders #12
Conversation
…structions Signed-off-by: Gabryel Nóbrega <[email protected]>
| function exit_timeout() { | ||
| echo '' | ||
| docker compose logs docusaurus | ||
| docker compose logs $SERVICE |
There was a problem hiding this comment.
Variable $SERVICE not previously set. Prefer passing arguments, makes syntax easier to understand.
You may do SERVICE=${2:default_service} and use as is and call exit_timeout time some_service.
| # Select service name and port based on environment | ||
| if [[ "$ENV" == "production" ]]; then | ||
| SERVICE="docusaurus-prod" | ||
| PORT=8080 | ||
| URL="http://localhost:$PORT/" | ||
| else | ||
| SERVICE="docusaurus-dev" | ||
| PORT=3000 | ||
| URL="http://localhost:$PORT/docs/basics/introduction" | ||
| fi |
There was a problem hiding this comment.
I like the approach to assume a single deployment mode, or at least assume production first.
Are you comfortable to assume a "production always" deployment?
This way, we don't incur the risk of testing something in dev mode and forgetting to configure the equivalent in the production mode. We might have a dev deployment, but I would feel more comfortable if it was an extension of the production, not a different scenario.
For production:
- the URL configured as
localhostmight present some issues,0.0.0.0is better, because listen in all configured interfaces instead of only the loopback. - the protocol used is HTTPS, not HTTP, HTTPS implements a layer of security and exchange of certificates.
- the port used is the 443, the default for HTTPS.
- you might still use the docussaurus in HTTP, but reverse proxy is needed, nginx is commonly used for that, it also adds the security layer needed for the HTTPS.
There was a problem hiding this comment.
Add execution permission to this file
| echo 'Navigate to http://localhost:3000/ to see the docs.' | ||
|
|
||
| xdg-open 'http://localhost:3000/docs/next/basics/introduction.html' || true | ||
| docker compose --compatibility up -d $SERVICE |
There was a problem hiding this comment.
Compose file is not accessible running ./scripts/create_docussaurus_website.sh
| # Select service name and port based on environment | ||
| if [[ "$ENV" == "production" ]]; then | ||
| SERVICE="docusaurus-prod" | ||
| PORT=8080 | ||
| URL="http://localhost:$PORT/" | ||
| else | ||
| SERVICE="docusaurus-dev" | ||
| PORT=3000 | ||
| URL="http://localhost:$PORT/docs/basics/introduction" | ||
| fi | ||
|
|
||
| # Run | ||
| echo "==> Starting Docusaurus in '$ENV' mode..." | ||
|
|
||
| docker compose down | ||
| docker build -t magma_docusaurus . | ||
| docker compose --compatibility up -d | ||
|
|
||
| echo '' | ||
| echo 'NOTE: README changes will live-reload. Sidebar changes require re-running this script.' | ||
| echo '' | ||
| echo 'Waiting for Docusaurus site to come up...' | ||
| echo 'If you want to follow the build logs, run docker compose logs -f docusaurus' | ||
| spin | ||
| echo 'Navigate to http://localhost:3000/ to see the docs.' | ||
|
|
||
| xdg-open 'http://localhost:3000/docs/next/basics/introduction.html' || true | ||
| docker compose --compatibility up -d $SERVICE | ||
|
|
||
| if [[ "$ENV" == "development" ]]; then | ||
| echo '' | ||
| echo 'NOTE: README changes will live-reload. Sidebar changes require re-running this script.' | ||
| echo '' | ||
| echo 'Waiting for Docusaurus site to come up...' | ||
| echo "If you want to follow the build logs: docker compose logs -f $SERVICE" | ||
| spin | ||
| fi | ||
|
|
||
| echo "==> Docusaurus is running at: $URL" | ||
| # xdg-open "$URL" || true |
There was a problem hiding this comment.
Create a main function is a good practice, but you could break this into more functions.
At the end, you call main.
| # ============================== | ||
| # Choose environment: development | production | ||
| # Default is "development" | ||
| ENV=${ENV:-development} |
There was a problem hiding this comment.
Receive as argument instead of environment variable.
There was a problem hiding this comment.
Add execution permission to this file.
Running ./scripts/check_sidebars/py returns nothing.
Script is not working, fix the execution path.
| ENV ?= development | ||
|
|
||
| start: ## Start Docusaurus site (default: ENV=development) | ||
| ENV=$(ENV) bash scripts/create_docusaurus_website.sh | ||
|
|
||
| dev: ## Alias to start in development mode | ||
| ENV=development bash scripts/create_docusaurus_website.sh | ||
|
|
||
| build: ## Alias to start in production mode | ||
| ENV=production bash scripts/create_docusaurus_website.sh |
There was a problem hiding this comment.
If you get the ENV from environment, you don't need to separate dev from production, call it docussaurus or leave as default, calling only make to build and run docussaurus, usually this is done in a all section in the makefile. And update documentation
There was a problem hiding this comment.
We have a Makefile at docussaurus/Makefile, remove that, as this file does the same thing.
Summary
docusaurus/docs/howtos/docusaurus.mdwhen chore: evaluate and port Conrado's PR #9 get's mergedTest Plan
Additional Information
Security Considerations
To be discussed at scheduled security meeting