Skip to content

Commit

Permalink
Merge pull request #202 from ricardozanini/issue-199
Browse files Browse the repository at this point in the history
Refactor website to use Hugo and Docsy; Add a blog
  • Loading branch information
ricardozanini authored Jun 27, 2024
2 parents 293df7d + 161a15c commit 8f2ed07
Show file tree
Hide file tree
Showing 279 changed files with 5,077 additions and 18,639 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @tsurdilo @duglin
* @ricardozanini @cdavernas
6 changes: 4 additions & 2 deletions .github/OWNERS
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
reviewers:
- tsurdilo
- ricardozanini
- cdavernas
approvers:
- tsurdilo
- ricardozanini
- cdavernas
labels:
- sig/contributor-experience
45 changes: 17 additions & 28 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,33 +1,22 @@
HELP.md
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**
!**/src/test/**
node_modules/
package-lock.json
/tmp

### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
# Hugo
.hugo_build.lock
/public
resources/

### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
# vim temporary files
*~
*.sw?

### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
# system files
.DS_Store

### VS Code ###
.vscode/
# IDE files
.idea

.DS_Store
# VS Code
/.vscode/**
!/.vscode/cspell.json
29 changes: 26 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
## Hacking on Serverless Workflow in Gitpod
# How to Contribute

If you have a web browser, you can get a fully pre-configured development environment in one click:
We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/serverlessworkflow/serverlessworkflow.github.io)
## Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License
Agreement. You (or your employer) retain the copyright to your contribution;
this simply gives us permission to use and redistribute your contributions as
part of the project. Head over to <https://cla.developers.google.com/> to see
your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one
(even if it was for a different project), you probably don't need to do it
again.

## Code reviews

All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
information on using pull requests.

## Community Guidelines

This project follows
[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).
4 changes: 4 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
FROM floryn90/hugo:ext-alpine

RUN apk add git && \
git config --global --add safe.directory /src
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
## Serverless Workflow Specification Website [![Netlify Status](https://api.netlify.com/api/v1/badges/3e2428ca-8d7f-426f-91cf-de4f68631600/deploy-status)](https://app.netlify.com/sites/serverlessworkflow/deploys) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/serverlessworkflow/serverlessworkflow.github.io)
# Serverless Workflow Website Repository

This repository includes sources for the Serverless Workflow Specification Website:
* [serverlessworkflow.org](http://serverlessworkflow.org)
* [serverlessworkflow.io](http://serverlessworkflow.io)
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

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/).

To contribute to the website you don't need to have in-deth web design knowledge:

- 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.
7 changes: 3 additions & 4 deletions _redirects
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# See: https://docs.netlify.com/routing/redirects/
# https://docs.netlify.com/routing/redirects/redirect-options/
/schemas/previous/* /schemas/0.7/:splat 200
/schemas/latest/* /schemas/0.8/:splat 200
/schemas/snapshot/* /schemas/0.9/:splat 200
/services/diagrams https://secure-diagram-service-sw-sw-diagram-service.rhba-cluster-0ad6762cc85bcef5745bb684498c2436-0000.us-south.containers.appdomain.cloud/swdiagram 200
/schemas/previous/* /schemas/0.8/:splat 200
/schemas/latest/* /schemas/0.9/:splat 200
/schemas/snapshot/* /schemas/1.0.0-alpha2/:splat 200
Loading

0 comments on commit 8f2ed07

Please sign in to comment.