Skip to content

Commit 0ca6158

Browse files
committed
Refactor website to use Hugo and Docsy; Add a blog
Signed-off-by: Ricardo Zanini <[email protected]>
1 parent 293df7d commit 0ca6158

File tree

231 files changed

+59
-32616
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

231 files changed

+59
-32616
lines changed

.github/CODEOWNERS

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @tsurdilo @duglin
1+
* @ricardozanini @cdavernas

.github/OWNERS

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
reviewers:
2-
- tsurdilo
2+
- ricardozanini
3+
- cdavernas
34
approvers:
4-
- tsurdilo
5+
- ricardozanini
56
labels:
67
- sig/contributor-experience

.gitignore

+17-28
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,22 @@
1-
HELP.md
2-
target/
3-
!.mvn/wrapper/maven-wrapper.jar
4-
!**/src/main/**
5-
!**/src/test/**
1+
node_modules/
2+
package-lock.json
3+
/tmp
64

7-
### STS ###
8-
.apt_generated
9-
.classpath
10-
.factorypath
11-
.project
12-
.settings
13-
.springBeans
14-
.sts4-cache
5+
# Hugo
6+
.hugo_build.lock
7+
/public
8+
resources/
159

16-
### IntelliJ IDEA ###
17-
.idea
18-
*.iws
19-
*.iml
20-
*.ipr
10+
# vim temporary files
11+
*~
12+
*.sw?
2113

22-
### NetBeans ###
23-
/nbproject/private/
24-
/nbbuild/
25-
/dist/
26-
/nbdist/
27-
/.nb-gradle/
28-
build/
14+
# system files
15+
.DS_Store
2916

30-
### VS Code ###
31-
.vscode/
17+
# IDE files
18+
.idea
3219

33-
.DS_Store
20+
# VS Code
21+
/.vscode/**
22+
!/.vscode/cspell.json

CONTRIBUTING.md

+26-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,28 @@
1-
## Hacking on Serverless Workflow in Gitpod
1+
# How to Contribute
22

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

5-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/serverlessworkflow/serverlessworkflow.github.io)
6+
## Contributor License Agreement
7+
8+
Contributions to this project must be accompanied by a Contributor License
9+
Agreement. You (or your employer) retain the copyright to your contribution;
10+
this simply gives us permission to use and redistribute your contributions as
11+
part of the project. Head over to <https://cla.developers.google.com/> to see
12+
your current agreements on file or to sign a new one.
13+
14+
You generally only need to submit a CLA once, so if you've already submitted one
15+
(even if it was for a different project), you probably don't need to do it
16+
again.
17+
18+
## Code reviews
19+
20+
All submissions, including submissions by project members, require review. We
21+
use GitHub pull requests for this purpose. Consult
22+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
23+
information on using pull requests.
24+
25+
## Community Guidelines
26+
27+
This project follows
28+
[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).

README.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
1-
## 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)
1+
# Serverless Workflow Website Repository
22

3-
This repository includes sources for the Serverless Workflow Specification Website:
4-
* [serverlessworkflow.org](http://serverlessworkflow.org)
5-
* [serverlessworkflow.io](http://serverlessworkflow.io)
3+
This repository hosts the website for the [Serveless Workflow Specification](https://github.com/serverlessworkflow/specification) project at [https://serverlessworkflow.io](https://serverlessworkflow.io).
4+
5+
## Contributing to the website
6+
7+
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/).
8+
9+
To contribute to the website you don't need to have in-deth web design knowledge:
10+
11+
- To add a new content [follow this guide](https://www.docsy.dev/docs/adding-content/content/)
12+
- 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).
13+
- 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.

_redirects

-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,3 @@
33
/schemas/previous/* /schemas/0.7/:splat 200
44
/schemas/latest/* /schemas/0.8/:splat 200
55
/schemas/snapshot/* /schemas/0.9/:splat 200
6-
/services/diagrams https://secure-diagram-service-sw-sw-diagram-service.rhba-cluster-0ad6762cc85bcef5745bb684498c2436-0000.us-south.containers.appdomain.cloud/swdiagram 200

community.html

-499
This file was deleted.

css/community.css

-1
This file was deleted.

css/editor/editor.main.css

-6
This file was deleted.

0 commit comments

Comments
 (0)