Skip to content

Migration to Astro #220

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

Merged
merged 8 commits into from
Jan 8, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.DS_Store
node_modules
dist
1 change: 0 additions & 1 deletion .github/CODEOWNERS

This file was deleted.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/website.md

This file was deleted.

8 changes: 0 additions & 8 deletions .github/OWNERS

This file was deleted.

7 changes: 0 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

34 changes: 18 additions & 16 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
# build output
dist/

# generated types
.astro/

# dependencies
node_modules/
package-lock.json
/tmp

# Hugo
.hugo_build.lock
/public
resources/
# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# vim temporary files
*~
*.sw?
# environment variables
.env
.env.production

# system files
# macOS-specific files
.DS_Store

# IDE files
.idea

# VS Code
/.vscode/**
!/.vscode/cspell.json
# jetbrains setting folder
.idea/
1 change: 0 additions & 1 deletion .gitpod.Dockerfile

This file was deleted.

16 changes: 5 additions & 11 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
image:
file: .gitpod.Dockerfile

# List the start up tasks. You can start them in parallel in multiple terminals.
# https://www.gitpod.io/docs/config-start-tasks/
tasks:
- command: python3 -m http.server

# List the ports you want to expose and what to do when they are served.
# https://www.gitpod.io/docs/config-ports/
- init: npm install
command: npm run dev

ports:
- port: 8080
onOpen: open-preview
- port: 4321
onOpen: open-browser

# Enable prebuilds of your project to enable faster workspace start times.
# https://www.gitpod.io/docs/prebuilds/#configure-the-github-app
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
20.11.1
4 changes: 4 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}
11 changes: 11 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "./node_modules/.bin/astro dev",
"name": "Development server",
"request": "launch",
"type": "node-terminal"
}
]
}
11 changes: 7 additions & 4 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
FROM floryn90/hugo:ext-alpine

RUN apk add git && \
git config --global --add safe.directory /src
FROM node:lts
WORKDIR /app
COPY . .
RUN npm i
RUN npx astro telemetry disable
EXPOSE 4321
CMD ["npx", "astro", "dev", "--host"]
37 changes: 32 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -2,12 +2,39 @@

This repository hosts the website for the [Serveless Workflow Specification](https://github.com/serverlessworkflow/specification) project at [https://serverlessworkflow.io](https://serverlessworkflow.io).

## Contributing to the website
## 🧑 Contributing to the website

The website uses [Hugo](https://gohugo.io/) and [Docsy](https://www.docsy.dev/). You can find more information about how to get started with this stack [here](https://www.docsy.dev/docs/get-started/).
The website uses [Astro](https://astro.build/). You can find more information about how to get started with this stack [here](https://docs.astro.build/en/getting-started/).

For the styling, it relies on [TailWind CSS](https://tailwindcss.com/) and [Daisy UI](https://daisyui.com/).

To contribute to the website you don't need to have in-deth web design knowledge:
- To publish a blog post just add a new Markdown page to the [`blog`](src/content/blog) directory. You can always use the blog posts in this repository as a reference.
- For more complex changes to the website, have a look at the [Astro Docs](https://docs.astro.build/en/getting-started/)

## 🚀 Project Structure

To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/).

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |


Alternatively, you can use Docker to run the project and connect on `localhost:4321`:
```
docker compose up --remove-orphans --watch
```

## 👀 Want to learn more?

- To add a new content [follow this guide](https://www.docsy.dev/docs/adding-content/content/)
- To publish a blog post just add a new Markdown page to the [`blog`](blog) directory. You can always use the blog posts in this repository as a reference. [Here's a good example](https://github.com/google/docsy-example/blob/main/content/en/blog/releases/in-depth-monoliths-detailed-spec.md).
- For more complex changes to the website, look at the [Docsy](https://github.com/google/docsy) repository as a reference. Sometimes you might need to change the [default templates](https://github.com/google/docsy/tree/main/layouts) to accomodate custom changes.
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
2 changes: 1 addition & 1 deletion _redirects
Original file line number Diff line number Diff line change
@@ -2,4 +2,4 @@
# https://docs.netlify.com/routing/redirects/redirect-options/
/schemas/previous/* /schemas/0.8/:splat 200
/schemas/latest/* /schemas/0.9/:splat 200
/schemas/snapshot/* /schemas/1.0.0-alpha2/:splat 200
/schemas/snapshot/* /schemas/1.0.0-alpha5/:splat 200
Loading